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

文档中心

立即注册

导航

DescribeAllowLists

最近更新时间：2024.11.05 16:00:06首次发布时间：2023.02.02 17:41:21

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

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	否	cn-beijing	地域 ID。说明您可以调用 DescribeRegions 接口查询可创建 MySQL 实例的地域信息，包括地域 ID。
InstanceId	String	否	mysql-h441603c****	实例 ID。当指定 InstanceId 时，DescribeAllowLists 接口会返回指定实例所绑定的白名单。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MySQL 实例的基本信息，包括实例 ID。

返回参数

参数	类型	示例值	描述
AllowLists	Object[]	请参见返回示例。	白名单信息列表。

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024031919043065E0B28E05E6A2AF458A",
        "Action": "DescribeAllowLists",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowLists": [
            {
                "AllowListCategory": "Default",
                "AllowListDesc": "",
                "AllowListIPNum": 4,
                "AllowListId": "acl-f90a90d96ee7401e912649bee4e2****",
                "AllowListName": "AllowlistName",
                "AllowListType": "IPv4",
                "AssociatedInstanceNum": 8,
                "SecurityGroupBindInfos": [
                    {
                        "BindMode": "IngressDirectionIp",
                        "IpList": [
                            "10.***.***.251/32",
                            "192.***.***.1/32",
                            "192.***.***.0/32",
                            "10..***.***.252/32"
                        ],
                        "SecurityGroupId": "sg-1mwy7b2bd0074j63v426****"
                    }
                ]
            }
        ]
    }
}

错误码

更多详情，请参见错误码。