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

文档中心

文档数据库 MongoDB 版

白名单管理

AssociateAllowList

调用 AssociateAllowList 接口将目标 MongoDB 实例绑定到指定 IP 白名单。

请求类型

异步请求。

注意事项

在文档数据库 MongoDB 版中使用白名单时存在一些约束和限制，具体限制请参见创建白名单。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
AllowListIds	String[]	是	["acl-c2402ba601374808aeb19d06acc2**","acl-b2a5bf3e471c433096232082c199**"]	需要绑定实例的白名单 ID。说明您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。支持一次传入多个白名单 ID，多个 ID 间用英文逗号（,）分隔。不支持同时传入多个实例 ID 和白名单，即仅允许一次将多个实例同时绑定到同一个白名单，或将一个实例同时绑定到多个白名单。
InstanceIds	String[]	是	["mongo-shard-011d2479****"]	需要绑定白名单的实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。支持一次传入多个实例 ID，多个 ID 间用英文逗号（,）分隔。不支持同时传入多个实例 ID 和白名单，即仅允许一次将多个实例同时绑定到同一个白名单，或将一个实例同时绑定到多个白名单。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=AssociateAllowList&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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=****
{
    "InstanceIds": [
        "mongo-shard-011d2479****"
    ],
    "AllowListIds": [
        "acl-c2402ba601374808aeb19d06acc2****,acl-b2a5bf3e471c433096232082c199****"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220316164600010225243081008D****",
        "Action": "AssociateAllowList",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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

最近更新时间：2025.08.18 16:48:14

这个页面对您有帮助吗？

有用

无用

文档数据库 MongoDB 版

请求类型 #

注意事项 #

调试 #

请求参数 #

返回参数 #

示例 #

请求示例 #

返回示例 #

错误码 #