云数据库 SQL Server 版
云数据库 SQL Server 版
文档指南
请输入
- 文档首页
云数据库 SQL Server 版API 参考白名单管理DescribeAllowListDetail - 查询白名单详情
复制全文
下载 pdfDescribeAllowListDetail - 查询白名单详情
文档反馈
问问助手调用 DescribeAllowListDetail 查询白名单详情。
请求说明
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeAllowListDetail
要执行的操作，取值：DescribeAllowListDetail。
Version string 必选 示例值：2022-01-01
API的版本，取值：2022-01-01。
AllowListId string 必选 示例值：acl-f0b3a98402144871ae22d3ef******
白名单 ID。
返回参数
AllowListId string 示例值：acl-9e73f3425e57405fbe7145cdac******
白名单 ID。
AllowListName string 示例值：test
白名单名称。
AllowListDesc string 示例值：Allowlist
白名单描述。
AllowListType string 示例值：IPv4
白名单内的 IP 地址类型。当前仅支持 IPv4 地址类型。
AllowList string 示例值：10.1.***.***
白名单内的 IP 地址列表。
说明
AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
AssociatedInstances object[] 示例值：[ { "InstanceId": "mssql-04a9110*****", "InstanceName": "mssql-04a9110*****", "VPC": "vpc-b8pzuqn05yio28j06j*****" } ]
绑定的实例列表。
InstanceId string 示例值：mssql-04a9110*****
实例 ID。
InstanceName string 示例值：mssql-04a9110*****
实例名称。
VPC string 示例值：vpc-b8pzuqn05yio28j06j*****
实例所属的私有网络 ID。
IsLatest boolean 示例值：true
是否同步最新白名单 IP。取值“
- true：是。
- false：否。
InstanceStatus string 示例值：Deleting
实例状态。实例状态，取值为：
- Running：运行中。
- Creating：创建中。
- Deleting：删除中。
- Restarting：重启中。
- Updating：变更中。
- MasterChanging：主备切换中。
- Error：错误。
ProjectName string 示例值：Default
实例所属项目名称。
SecurityGroupBindInfos object[] 示例值：[ { "BindMode": "IngressDirectionIp", "IpList": [ "10.1.1.2/32", "10.1.1.1/32" ], "SecurityGroupId": "sg-30up5lo07p7nk7r2qr******", "SecurityGroupName": "Default" } ]
当前白名单已关联的安全组信息列表。
说明
仅当白名单中存在已关联的安全组时，才会返回该参数。
UserAllowList string 示例值：100.64.****.****/10
该名单中您输入的 IP 地址。
说明
AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
ProjectName string 示例值：Default
所属项目名称。
AssociatedInstanceNum long 示例值：2
绑定的实例数量。
AllowListCategory string 示例值：Default
白名单类别。取值：
- Ordinary：普通白名单（默认值）。
- Default：默认白名单。
请求示例
POST /?Action=DescribeAllowListDetail&Version=2022-01-01 HTTP/1.1
Host: rds-mssql.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251117T092153Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251117/cn-beijing/rds_mssql/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"AllowListId": "acl-b5a1d7f114714315b6987*********"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2025051411220873B50BBA7E25A766B623-ca80a3",
"Action": "DescribeAllowListDetail",
"Version": "2022-01-01",
"Service": "rds_mssql",
"Region": "cn-beijing"
},
"Result": {
"AllowList": "0.0.****.****/0,100.64.****.****/10",
"AllowListCategory": "Ordinary",
"AllowListDesc": "",
"AllowListId": "acl-9e73f3425e57405fbe7145cdac*****",
"AllowListName": "DBW_Sole_Group_Name_For_mssql",
"AllowListType": "IPv4",
"AssociatedInstances": [
{
"InstanceId": "mssql-04a9110*****",
"InstanceName": "mssql-04a9110*****",
"VPC": "vpc-b8pzuqn05yio28j06j*****"
}
],
"SecurityGroupBindInfos": [
{
"BindMode": "AssociateEcsIp",
"SecurityGroupId": "sg-b8pzuwk3i4g028j06k*****",
"SecurityGroupName": "Default"
},
{
"BindMode": "IngressDirectionIp",
"IpList": [
"0.0.0.0/0"
],
"SecurityGroupId": "sg-b8pzuwk3i4g028j06k*****",
"SecurityGroupName": "Default"
}
],
"UserAllowList": "100.64.****.****/10",
"ProjectName": "default",
"AssociatedInstanceNum": 2
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidParameter | The specified parameter %s is not valid. | 参数 {parameter1} 值无效。 |
最近更新时间：2026.01.16 15:28:45
这个页面对您有帮助吗？
有用
有用
无用
无用