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

文档中心

立即注册

导航

DescribeAllowListDetail

最近更新时间：2024.11.08 10:14:36首次发布时间：2022.08.20 16:54:39

调用 DescribeAllowListDetail 接口查询目标白名单的详细信息，包括 IP 地址和绑定的实例详情。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
AllowListId	String	是	acl-b2a5bf3e471c433096232082c199****	白名单 ID。说明您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。

返回参数

名称	类型	示例值	描述
AllowList	String	10.1.*.,10.2..*/24	白名单内的 IP 地址列表。
AllowListDesc	String	test	白名单的备注。
AllowListId	String	acl-d1fd76693bd54e658912e7337d5b****	白名单 ID。
AllowListName	String	test	白名单名称。
AllowListType	String	IPv4	白名单内的 IP 地址类型。当前仅支持指定为 `IPv4`，表示 IPv4 地址。
AssociatedInstanceNum	Integer	0	已绑定的实例数量。
ProjectName	String	default	白名单所属的项目名称。
AssociatedInstances	Array of AssociatedInstanceInfo	请参见返回示例。	已绑定当前白名单的实例信息。详细信息，请参见 AssociatedInstanceInfo。

请求示例

POST /?Action=DescribeAllowListDetail&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220614T114308Z
Authorization: HMAC-SHA256 Credential=AKIAIAGMBG4SXSQQ****/20220614/cn-beijing/veDB/request, SignedHeaders=accept;content-type;host;x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****

{
    "AllowListId":"acl-04908986ad034ac0ba1fb1e3a754****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202203161507260102252431180088****",
        "Action": "DescribeAllowListDetail",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
         "AllowList": "10.1.***.***,10.2.***.***/24",
         "AllowListDesc": "test",
         "AllowListId": "acl-d1fd76693bd54e658912e7337d5b****",
         "AllowListName": "test",
         "AllowListType": "IPv4",
         "AssociatedInstanceNum": 1,
         "AssociatedInstances": [
             {
                 "InstanceId": "vedbm-ca12cbqv****",
                 "InstanceName": "test",
                 "ProjectName": "default",
                 "VPC": "vpc-3tgjebmlgq4e8i4m****"
             }
         ],
         "ProjectName": "default"
    }
}

## 错误码

更多详情，请参见[错误码](../6357/96181)。