云数据库 MySQL 版
云数据库 MySQL 版
云数据库 MySQL 版
文档指南
请输入
产品动态
内核功能
功能
用户指南
实例管理
连接管理
管理连接终端
备份恢复
服务可用性
日志管理
数据安全管理
参数管理
跨地域备份管理
API 参考
V2（2022-01-01）
实例管理
连接管理
账号管理
数据库管理
安全加密
备份与恢复
参数管理
资源包管理
附录
开发者工具
最佳实践
相关协议
- 文档首页
云数据库 MySQL 版API 参考V2（2022-01-01）安全加密DescribeAllowListDetail - 查看白名单详情
复制全文
下载 pdfDescribeAllowListDetail - 查看白名单详情
文档反馈
问问助手调用 DescribeAllowListDetail 接口查看白名单详情。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
AllowListId | String | 是 | acl-b2a5bf3e471c433096232082c199**** | 白名单 ID。 说明 |
ProjectName | String | 否 | default | 所属的项目。 说明 如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
AllowList | String | 10.1..,10.2../24 | 白名单内的 IP 地址列表。 |
AllowListCategory | String | Default | 白名单分类。取值：
说明 该参数作为请求参数时，默认值为 Ordinary。 |
AllowListDesc | String | test | 白名单的备注。 |
AllowListId | String | acl-d1fd76693bd54e658912e7337d5b*** | 白名单 ID 。 |
AllowListName | String | test | 白名单名称。 |
AllowListType | String | IPv4 | 白名单内的 IP 地址类型。当前仅支持 IPv4 地址。 |
AssociatedInstances | [{ "InstanceId": "mysql-e26822cf****", "InstanceName": "test", "VPC": "vpc-3tgjebmlgq4e8i4m***" }] | 已绑定当前白名单的实例信息。 | |
ProjectName | String | default | 白名单所属的项目。 说明 如白名单为存量白名单且尚未归属至具体项目，则返回为空。 |
SecurityGroupBindInfos | 请参见返回示例。 | 白名单关联的安全组的信息。 说明 如白名单未绑定安全组，则不返回该参数。 | |
UserAllowList | String | 10...1 | 该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。 |
AssociatedInstanceObject
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
InstanceId | String | mysql-h441603c**** | 已绑定当前白名单的实例 ID。 |
InstanceName | String | test | 已绑定当前白名单的实例名称。 |
InstanceStatus | String | Running | 实例状态。 |
IsLatest | Boolean | true | 是否已同步最新的白名单。取值：
说明 在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。 |
VPC | String | vpc-2743n1ihbxla87fap8tap**** | 实例所属的私有网络 ID。 |
SecurityGroupBindInfo
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
BindMode | String | AssociateEcsIp | 关联安全组的模式。取值：
说明 在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。 |
SecurityGroupId | String | sg-b8pzuwk3i4g028j06k8f**** | 安全组 ID。 说明 在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。 |
IpList | Array of String | ["10...1/32","10...2/32"] | 安全组的 IP。 |
示例
请求示例
POST /?Action=DescribeAllowListDetail&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"AllowListId": "acl-04908986ad034ac0ba1fb1e3a754****"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2024031919065456B2AA76C3D558CD4485",
"Action": "DescribeAllowListDetail",
"Version": "2022-01-01",
"Service": "rds_mysql",
"Region": "cn-beijing"
},
"Result": {
"AllowList": "1.1.1.1,2.2.2.2",
"AllowListCategory": "Ordinary",
"AllowListDesc": "",
"AllowListId": "acl-04908986ad034ac0ba1fb1e3a754****",
"AllowListName": "测试白名单",
"AllowListType": "IPv4",
"AssociatedInstances": [
{
"InstanceId": "mysql-b11255cc****",
"InstanceName": "测试实例1",
"InstanceStatus": "Restarting",
"IsLatest": false,
"VPC": "vpc-b81xq5qk9wjk28j06k3l****"
},
{
"InstanceId": "mysql-d7127b90****",
"InstanceName": "测试实例2",
"InstanceStatus": "Running",
"IsLatest": true,
"VPC": "vpc-b8pzuqn05yio28j06j1v****"
}
],
"ProjectName": "default",
"SecurityGroupBindInfos": [
{
"BindMode": "IngressDirectionIp",
"IpList": [
"1.1.1.1",
"2.2.2.2"
],
"SecurityGroupId": "sg-24mm6n4***1hc4acvz5is****",
"SecurityGroupName": "测试安全组"
}
],
"UserAllowList": "1.***.***.0,2.***.***.0"
}
}
错误码
最近更新时间：2026.04.09 11:58:29
这个页面对您有帮助吗？
有用
有用
无用
无用