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

DescribeAllowLists

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

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

我的收藏

调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息。

请求类型

同步请求。

请求参数

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

RegionId

String

是

cn-beijing

地域 ID。

说明

您可以调用 DescribeRegions 接口查询可创建 MongoDB 实例的地域信息，包括地域 ID。

InstanceId

String

否

mongo-replica-cn014a009e8b****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。

返回参数

参数类型示例值描述
AllowListsArray of AllowListInfo请参见返回示例。白名单信息列表。

AllowListInfo

参数类型示例值描述
AllowListIdStringacl-d1fd76693bd54e658912e7337d5b****白名单 ID。
AllowListDescStringtest白名单的备注。
AllowListNameStringtest白名单名称。
AllowListTypeStringIPv4白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AllowListIPNumLong2白名单内的 IP 地址（或地址段）总数。
AssociatedInstanceNumLong1白名单下绑定的实例总数。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeAllowLists&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=****
{
    "RegionId": "cn-beijing",
    "InstanceId": "mongo-replica-e405f8e2****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202211102131170102081741611F78****",
        "Action": "DescribeAllowLists",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowLists": [
            {
                "AllowListDesc": "test",
                "AllowListIPNum": 4,
                "AllowListId": "acl-5dbb971355fb4e77b21c2cd59179****",
                "AllowListName": "ecs_list",
                "AllowListType": "IPv4",
                "AssociatedInstanceNum": 2
            }
        ]
    }
}