DescribeAllowListDetail--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

DescribeAllowListDetail

最近更新时间：2024.10.17 14:42:41首次发布时间：2022.04.12 11:06:53

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

请求类型

同步请求。

请求参数

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

返回参数

参数	类型	示例值	描述
AllowListId	String	acl-6c95b7ada03143778ce6978455ca****	白名单 ID。
AllowListName	String	ecs_ip	白名单名称。
AllowListDesc	String	test	白名单的备注。
AllowListType	String	IPv4	白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AllowList	String	10.1.\\\.\\\,10.2.\\\.\\\/24	白名单内的 IP 地址列表。
AssociatedInstances	Object[]		已绑定当前白名单的实例信息。
ProjectName	String	default	当前白名单所属的项目。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeAllowListDetail&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "AllowListId": "acl-6c95b7ada03143778ce6978455ca****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202203161507260102252431180088****",
        "Action": "DescribeAllowListDetail",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowList": "10.1.***.***,10.2.***.***/24",
        "AllowListDesc": "test",
        "AllowListId": "acl-6c95b7ada03143778ce6978455ca****",
        "AllowListName": "ecs_ip",
        "AllowListType": "IPv4",
        "AssociatedInstances": [
            {
                "InstanceId": "mongo-replica-e405f8e2****",
                "InstanceName": "test",
                "ProjectName": "default",
                "VPC": "vpc-3tgjebmlgq4e8i4m****"
            }
        ],
        "ProjectName": "default"
    }
}

错误码

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