云数据库 MySQL 版
云数据库 MySQL 版
云数据库 MySQL 版
文档指南
请输入
产品动态
内核功能
功能
用户指南
实例管理
连接管理
管理连接终端
备份恢复
服务可用性
日志管理
数据安全管理
参数管理
跨地域备份管理
API 参考
V2（2022-01-01）
实例管理
连接管理
账号管理
数据库管理
安全加密
备份与恢复
参数管理
资源包管理
附录
开发者工具
最佳实践
相关协议
- 文档首页
云数据库 MySQL 版API 参考V2（2022-01-01）安全加密DescribeAllowLists - 查看白名单列表
复制全文
下载 pdfDescribeAllowLists - 查看白名单列表
文档反馈
问问助手调用 DescribeAllowLists 接口查看白名单列表。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
RegionId | String | 否 | cn-beijing | 地域 ID。 说明 如通过该参数指定了地域，则会返回指定地域下满足其他查询条件的白名单列表。如未指定，则返回为空。您可以调用 DescribeRegions 接口查询可创建 MySQL 实例的地域信息，包括地域 ID。 |
InstanceId | String | 否 | mysql-h441603c**** | 实例 ID。 当指定 InstanceId 时，DescribeAllowLists 接口会返回指定实例所绑定的白名单。 说明 |
QueryDefault | Boolean | 否 | false | 是否仅查询默认白名单。取值：
|
IPAddress | String | 否 | "2.2.2.2,1.1.1.1" | 按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。 说明 如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。 |
ProjectName | String | 否 | default | 所属的项目。 说明 如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。 |
WithIpList | Boolean | 否 | true | 是否返回白名单包含的 IP 地址和 IP 地址段的列表。取值：
|
QueryInstance | Boolean | 否 | | 查询实例所绑定的白名单。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
AllowLists | 请参见返回示例。 | 白名单信息列表。 |
AllowListObject
参数 | 类型 | 示例值 | 描述 |
AllowListCategory | String | Default | 白名单分类。取值：
说明 该参数作为请求参数时，默认值为 Ordinary。 |
AllowListDesc | String | test | 白名单的备注。 |
AllowListId | String | acl-d1fd76693bd54e658912e7337d5b**** | 白名单 ID。 |
AllowListName | String | test | 白名单名称。 |
AllowListIPNum | Integer | 2 | 白名单内的 IP 地址（或地址段）总数。 |
AllowListType | String | IPv4 | 白名单内的 IP 地址类型。当前仅支持 IPv4 地址。 |
AssociatedInstanceNum | Integer | 1 | 白名单下绑定的实例总数。 |
IpList | Array of String | [ "172...0/18","192...6","10...1/32","10...2/32" ] | 白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。 |
ProjectName | String | default | 白名单所属的项目。 说明 如白名单为存量白名单且尚未归属至具体项目，则返回为空。 |
SecurityGroupBindInfos | 无。 | 白名单关联的安全组的信息。 说明 如白名单未绑定安全组，则不返回该参数。 |
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。 |
SecurityGroupName | String | 测试安全组 | 安全组名称。 说明 在 DescribeAllowLists 接口中，SecurityGroupBindInfoObject 作返回参数时不返回该字段。 |
示例
请求示例
POST /?Action=DescribeAllowLists&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****
{
"InstanceId": "mysql-h441603c****",
"RegionId": "cn-beijing",
"WithIpList": true
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2024031919043065E0B28E05E6A2AF458A",
"Action": "DescribeAllowLists",
"Version": "2022-01-01",
"Service": "rds_mysql",
"Region": "cn-beijing"
},
"Result": {
"AllowLists": [
{
"AllowListCategory": "Default",
"AllowListDesc": "",
"AllowListIPNum": 4,
"AllowListId": "acl-f90a90d96ee7401e912649bee4e2****",
"AllowListName": "AllowlistName",
"AllowListType": "IPv4",
"AssociatedInstanceNum": 8,
"IpList": [
"172.***.***.0/18",
"192.***.***.6",
"10.***.***.1/32",
"10.***.***.2/32"
],
"ProjectName": "default",
"SecurityGroupBindInfos": [
{
"BindMode": "IngressDirectionIp",
"IpList": [
"10.***.***.251/32",
"192.***.***.1/32",
"192.***.***.0/32",
"10..***.***.252/32"
],
"SecurityGroupId": "sg-1mwy7b2bd0074j63v426****"
}
]
}
]
}
}
错误码
最近更新时间：2026.05.28 11:52:20
这个页面对您有帮助吗？
有用
有用
无用
无用