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

文档中心

立即注册

导航

DescribeAllowListDetail

最近更新时间：2025.08.26 15:07:34首次发布时间：2024.04.28 11:36:22

调用 DescribeAllowListDetail 接口查看白名单详情。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
AllowListId	String	是	acl-fe1339b0024e42ca9872e8f4af12****	白名单的 ID。

返回参数

参数	类型	示例值	描述
AllowListId	String	acl-fe1339b0024e42ca9872e8f4af12****	白名单的 ID。
AllowListName	String	测试白名单	白名单的名称。
AllowListDesc	String	这是一段白名单的描述信息。	白名单的描述信息。
AllowListType	String	IPv4	白名单采用的网络协议类型。取值为 `IPv4`。
AllowList	String	10.1.1.1,10.2.2.0/24	白名单包含的所有的 IP 地址或 IP 地址段列表。
AllowListCategory	String	Default	白名单分类。取值： `Ordinary`：普通白名单。 `Default`：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
AssociatedInstanceNum	Long	8	该白名单绑定的实例数量。
AssociatedInstances	Object[]	请参见返回示例。	该白名单绑定的实例列表，包含实例 ID 和实例名称信息。
SecurityGroupBindInfos	Object[]	请参见返回示例。	该白名单绑定的安全组列表。
UserAllowList	String	10.1.1.1,10.2.3.0/24	安全组之外的、加入白名单的 IP 地址。

示例

请求示例

POST /?Action=DescribeAllowListDetail&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****
{
    "AllowListId": "acl-fe1339b0024e42ca9872e8f4af12****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202507171609269A59EE64CB5BAB44E8A6-33e3b7",
        "Action": "DescribeAllowListDetail",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowList": "1.***.***.1,192.***.***.40,192.***.***.108,192.16***8.***.3",
        "AllowListCategory": "Ordinary",
        "AllowListDesc": "",
        "AllowListId": "acl-9a5faa2306a945b69fea4a65f31f****",
        "AllowListName": "test_allowlist",
        "AllowListType": "IPv4",
        "AssociatedInstanceNum": 8,
        "AssociatedInstances": [
            {
                "InstanceId": "postgres-f006d308****",
                "InstanceName": "测试实例",
                "VPC": "vpc-2gdku6nvnp1xc50ztz0py****"
            }
        ],
        "SecurityGroupBindInfos": [
            {
                "BindMode": "AssociateEcsIp",
                "SecurityGroupId": "sg-2gdgzrxi8uigw50ztz0e9****"
            },
            {
                "BindMode": "AssociateEcsIp",
                "IpList": [
                    "192.***.***.40",
                    "192.***.***.108",
                    "192.***.***.3"
                ],
                "SecurityGroupId": "sg-2gdku6tsr17uo50ztyz9h****"
            },
            {
                "BindMode": "AssociateEcsIp",
                "SecurityGroupId": "sg-30ud5qcwpx6v47r2qr1kl****"
            }
        ],
        "UserAllowList": "1.***.***.1"
    }
}