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

文档中心

立即注册

导航

DescribeAllowListDetail

最近更新时间：2025.01.22 12:04:43首次发布时间：2023.02.02 17:41:21

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

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
AllowListId	String	是	acl-b2a5bf3e471c433096232082c199****	白名单 ID。说明您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。
ProjectName	String	否	default	所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。

返回参数

参数	类型	示例值	描述
AllowList	String	10.1.*.,10.2..*/24	白名单内的 IP 地址列表。
AllowListCategory	String	Default	白名单分类。取值： `Ordinary`：普通白名单。 `Default`：默认白名单。说明该参数作为请求参数时，默认值为 `Ordinary`。
AllowListDesc	String	test	白名单的备注。
AllowListId	String	acl-d1fd76693bd54e658912e7337d5b***	白名单 ID 。
AllowListName	String	test	白名单名称。
AllowListType	String	IPv4	白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AssociatedInstances	Object[]	[{ "InstanceId": "mysql-e26822cf**", "InstanceName": "test", "VPC": "vpc-3tgjebmlgq4e8i4m*" }]	已绑定当前白名单的实例信息。
SecurityGroupBindInfos	Object[]	请参见返回示例。	白名单关联的安全组的信息。
UserAllowList	String	10.*.*.1	该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024031919065456B2AA76C3D558CD4485",
        "Action": "DescribeAllowListDetail",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowList": "1.1.1.1,2.2.2.2",
        "AllowListCategory": "Ordinary",
        "AllowListDesc": "",
        "AllowListId": "acl-04908986ad034ac0ba1fb1e3a754****",
        "AllowListName": "测试白名单",
        "AllowListType": "IPv4",
        "AssociatedInstances": [
            {
                "InstanceId": "mysql-b11255cc****",
                "InstanceName": "测试实例1",
                "InstanceStatus": "Restarting",
                "IsLatest": false,
                "VPC": "vpc-b81xq5qk9wjk28j06k3l****"
            },
            {
                "InstanceId": "mysql-d7127b90****",
                "InstanceName": "测试实例2",
                "InstanceStatus": "Running",
                "IsLatest": true,
                "VPC": "vpc-b8pzuqn05yio28j06j1v****"
            }
        ],
        "SecurityGroupBindInfos": [
            {
                "BindMode": "IngressDirectionIp",
                "IpList": [
                    "1.1.1.1",
                    "2.2.2.2"
                ],
                "SecurityGroupId": "sg-24mm6n4voa1hc4acvz5is****",
                "SecurityGroupName": "测试安全组"
            }
        ],
        "UserAllowList": "1.***.***.0,2.***.***.0"
    }
}
json

错误码

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

DescribeAllowLists

CreateAllowList