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

文档中心

立即注册

导航

DescribeAllowLists

最近更新时间：2024.12.12 21:46:13首次发布时间：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。
ProjectName	String	否	default	白名单所属的项目。说明若该参数留空，表示不使用白名单的项目名称条件进行筛选。

返回参数

参数	类型	示例值	描述
AllowLists	Object[]		白名单信息列表。

示例

请求示例

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-cn014a009e8b****"
}

返回示例

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

错误码

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