文档中心

云数据库 SQL Server 版

白名单管理

DescribeInstanceAllowLists - 查询实例绑定的白名单列表

调用 DescribeInstanceAllowLists 接口查询实例绑定的白名单列表。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeInstanceAllowLists

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

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

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

RegionId string 必选示例值：cn-beijing

地域 ID。

说明

您可以调用 DescribeRegions 接口查看地域 ID。

InstanceId string 可选示例值：mssql-04a9110****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 SQL Server 实例的基本信息，包括实例 ID。

返回参数

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

AuthorizedAllowLists object[] 示例值：[ { "AllowListCategory": "Ordinary", "AllowListDesc": "", "AllowListIPNum": 2, "AllowListId": "acl-9501e882510249348c1990a30******", "AllowListName": "dyh-test-sg", "AllowListType": "IPv4", "AssociatedInstanceNum": 0, "ProjectName": "", "SecurityGroupBindInfos": [ { "BindMode": "IngressDirectionIp", "IpList": [ "10.1.1.2/32", "10.1.1.1/32" ], "SecurityGroupId": "sg-30up5lo07p7nk7r2qr******" } ] } ]

实例绑定的白名单列表。

AllowListId string 示例值：acl-9501e882510249348c1990a30******

白名单 ID。

AllowListName string 示例值：test

白名单名称。

AllowListDesc string 示例值：描述

白名单描述。

AllowListType string 示例值：IPv4

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

AllowListIPNum long 示例值：2

白名单内 IP 地址的数量。

AssociatedInstanceNum long 示例值：0

白名单关联的实例数量。

AssociatedLBNum long 示例值：2

白名单关联的 LB 的数量。

ProjectName string 示例值：Default

白名单所属的项目名称。

SecurityGroupBindInfos object[] 示例值：[ { "BindMode": "IngressDirectionIp", "IpList": [ "10.1.1.2/32", "10.1.1.1/32" ], "SecurityGroupId": "sg-30up5lo07p7nk7r2qr******" } ]

白名单绑定安全组。

AllowListCategory string 示例值：Ordinary

白名单分类。取值：

Ordinary：普通白名单。

Default：默认白名单。

UnauthorizedAllowListNum long 示例值：2

无权限的白名单总数。

请求示例

POST /?Action=DescribeInstanceAllowLists&Version=2022-01-01 HTTP/1.1​
Host: rds-mssql.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20251117T070858Z​
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​
​
{​
  "RegionId": "cn-beijing",​
  "InstanceId": "mssql-dab1be87****"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2025051317510473B1EF8F50DAB40480A4-cb45fa",​
        "Action": "DescribeInstanceAllowLists",​
        "Version": "2022-01-01",​
        "Service": "rds_mssql",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "AuthorizedAllowLists": [​
            {​
                "AllowListCategory": "Ordinary",​
                "AllowListDesc": "",​
                "AllowListIPNum": 2,​
                "AllowListId": "acl-9501e882510249348c1990a30******",​
                "AllowListName": "dyh-test-sg",​
                "AllowListType": "IPv4",​
                "AssociatedInstanceNum": 0,​
                "ProjectName": "",​
                "SecurityGroupBindInfos": [​
                    {​
                        "BindMode": "IngressDirectionIp",​
                        "IpList": [​
                            "10.1.1.2/32",​
                            "10.1.1.1/32"​
                        ],​
                        "SecurityGroupId": "sg-30up5lo07p7nk7r2qr******"​
                    }​
                ]​
            }​
        ],​
        "UnauthorizedAllowListNum": 0​
    }​
}​

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。

最近更新时间：2026.06.17 17:57:27

这个页面对您有帮助吗？

有用

无用