DescribeAllowLists--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

DescribeAllowLists

最近更新时间：2025.08.25 20:25:19首次发布时间：2024.04.28 11:36:22

调用 DescribeAllowLists 接口查看指定地域下的白名单列表。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID，可调用 DescribeRegions 接口查询。
InstanceId	String	否	postgres-sdasd***	实例 ID。说明如不设定该字段，返回当前地域下的所有白名单。如设定该字段，则返回该实例的所有白名单。
AllowListCategory	String	否	Default	白名单分类。取值： `Ordinary`：普通白名单。 `Default`：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
AllowListDesc	String	否	这是一段白名单的描述信息。	白名单的描述信息。可通过描述信息进行模糊搜索。
AllowListId	String	否	acl-fe1339b0024e42ca9872e8f4af12****	白名单 ID。
AllowListName	String	否	Test_Allowlist	白名单的名称。
IPAddress	String	否	"2.2.2.2,1.1.1.1"	按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
PageNumber	Long	否	2	当前页页码。取值最小为 1。默认值为 1。
PageSize	Long	否	20	每页记录数。取值最小为 1，且不超过 Integer 的最大值。无默认值。

返回参数

参数	类型	示例值	描述
AllowLists	Object[]	请参见返回示例。	白名单信息。
Total	Long	20	白名单的总数。

示例

请求示例

POST /?Action=DescribeAllowLists&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "RegionId": "cn-guangzhou",
    "InstanceId": "postgres-4b38053d****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240423185439A247C098FE59A9DE6193-3ecfa4",
        "Action": "DescribeAllowLists",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "AllowLists": [
            {
                "AllowListCategory": "Ordinary",
                "AllowListDesc": "",
                "AllowListIPNum": 4,
                "AllowListId": "acl-9a5faa2306a945b69fea4a65f31f****",
                "AllowListName": "test-allowlist",
                "AllowListType": "IPv4",
                "AssociatedInstanceNum": 0,
                "SecurityGroupBindInfos": [
                    {
                        "BindMode": "AssociateEcsIp",
                        "SecurityGroupId": "sg-2gdgzrxi8uigw50ztz0e9****"
                    },
                    {
                        "BindMode": "AssociateEcsIp",
                        "IpList": [
                            "192.***.***.40",
                            "192.***.***.108",
                            "192.***.***.3"
                        ],
                        "SecurityGroupId": "sg-2gdku6tsr17uo50ztyz9h****"
                    },
                    {
                        "BindMode": "AssociateEcsIp",
                        "SecurityGroupId": "sg-30ud5qcwpx6v47r2qr1kl****"
                    }
                ]
            }
        ]
    }
}