文档中心

云数据库 SQL Server 版

白名单管理

DescribeAllowLists - 查询白名单列表

调用 DescribeAllowLists 接口查询白名单列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeAllowLists

要执行的操作，取值：DescribeAllowLists。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

ProjectName string 可选示例值：Default

白名单所属的项目。

说明

若该参数留空，表示不使用白名单的项目名称条件进行筛选。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

AllowLists object[] 示例值：[ { "AllowListId": "acl-cdcbb69328cd40b7a9fa5d4c2cf8****", "AllowListDesc": "test", "AllowListName": "test_allowlist", "AllowListType": "IPv4", "AllowListIPNum": 395, "AssociatedInstanceNum": 181, "ProjectName": "test_project", "AllowListCategory": "Default", "SecurityGroupBindInfos": [ { "BindMode": "IngressDirectionIp", "IpList": [ "10.1.1.2/32", "10.1.1.1/32" ], "SecurityGroupId": "sg-30up5lo07p7nk7r2qr******" } ] } ]

白名单列表。

AllowListId string 示例值：acl-cdcbb69328cd40b7a9fa5d4c2cf8****

白名单 ID。

AllowListDesc string 示例值：test

白名单描述。

AllowListName string 示例值：Allowlist

白名单名称。

AllowListType string 示例值：IPv4

白名单内的 IP 地址类型。当前仅支持 IPv4 地址。

AllowListIPNum long 示例值：5

白名单内的 IP 地址（或地址段）总数。

AssociatedInstanceNum long 示例值：5

白名单下绑定的实例总数。

ProjectName string 示例值：Default

白名单所属的项目。

AllowListCategory string 示例值：Default

白名单类型。取值范围如下：

Ordinary：普通白名单。

Default：默认白名单。

SecurityGroupBindInfos object[] 示例值：[ { "BindMode": "AssociateEcsIp", "SecurityGroupId": "sg-b8pzuwk3i4g028j06k*****", "SecurityGroupName": "Default" }, { "BindMode": "IngressDirectionIp", "IpList": [ "0.0.0.0/0" ], "SecurityGroupId": "sg-b8pzuwk3i4g028j06k*****", "SecurityGroupName": "Default" } ]

安全组绑定信息。

Total long 示例值：5

白名单总数。

请求示例

POST /?Action=DescribeAllowLists&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mssql.cn-beijing.volcengineapi.com​
X-Date: 20230131T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
​
{​
    "ProjectName": "default"​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "2025111717534101113502116763DB68",​
    "Action": "DescribeAllowLists",​
    "Version": "2022-01-01",​
    "Service": "rds_mssql",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "AllowLists": [​
      {​
        "AllowListId": "acl-cdcbb69328cd40b7a9fa5d4c2cf8****",​
        "AllowListDesc": "test",​
        "AllowListName": "test_allowlist",​
        "AllowListType": "IPv4",​
        "AllowListIPNum": 395,​
        "AssociatedInstanceNum": 181,​
        "ProjectName": "test_project",​
        "AllowListCategory": "Default",​
        "SecurityGroupBindInfos": [​
            {​
                "BindMode": "IngressDirectionIp",​
                "IpList": [​
                    "10.1.1.2/32",​
                    "10.1.1.1/32"​
                ],​
                "SecurityGroupId": "sg-30up5lo07p7nk7r2qr******"​
            }​
          ]​
      }​
    ],​
    "Total": 51​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。
404	InvalidInstance.NotFound	The specified instance does not exist.	实例不存在。
500	InternalError	The request has failed with internal server error.	内部错误。

最近更新时间：2026.01.16 16:15:06

这个页面对您有帮助吗？

有用

无用