You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /
  • 文档数据库 MongoDB 版

DescribeAllowListDetail

最近更新时间：2024.04.26 11:09:08

首次发布时间：2022.04.12 11:06:53

我的收藏

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

请求类型

同步请求。

请求参数

参数类型是否必选示例值描述

AllowListId

String

是

acl-b2a5bf3e471c433096232082c199****

白名单 ID。

说明

您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。

返回参数

参数类型示例值描述
AllowListIdStringacl-d1fd76693bd54e658912e7337d5b****白名单 ID。
AllowListNameStringtest白名单名称。
AllowListDescStringtest白名单的备注。
AllowListTypeStringIPv4白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AllowListString10.1.***.***,10.2.***.***/24白名单内的 IP 地址列表。
AssociatedInstancesArray of AssociatedInstanceInfo请参见返回示例。已绑定当前白名单的实例信息。

AssociatedInstanceInfo

参数类型示例值描述
VPCStringvpc-2743n1ihbxla87fap8tap****实例所属的私有网络 ID。
InstanceIdStringmongo-replica-e405f8e2****已绑定当前白名单的实例 ID。
InstanceNameStringtest已绑定当前白名单的实例名称。

示例

请求示例

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-04908986ad034ac0ba1fb1e3a754****"
}

返回示例

{
    "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-d1fd76693bd54e658912e7337d5b****",
        "AllowListName": "test",
        "AllowListType": "IPv4",
        "AssociatedInstances": [
            {
                "InstanceId": "mongo-replica-e405f8e2****",
                "InstanceName": "test",
                "VPC": "vpc-3tgjebmlgq4e8i4m****"
            }
        ]
    }
}