文档数据库 MongoDB 版
文档数据库 MongoDB 版
文档指南
请输入
- 文档首页
文档数据库 MongoDB 版API 参考白名单管理ModifyAllowList
复制全文
下载 pdfModifyAllowList
文档反馈
问问助手调用 ModifyAllowList 接口修改目标白名单设置（例如白名单名称、IP 白名单地址、是否设置为默认白名单等）。
请求类型
异步请求。
注意事项
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
AllowListId String 必选 示例值：acl-04908986ad034ac0ba1fb1e3a754****
白名单 ID。
说明
AllowListName String 必选 示例值：test
白名单名称。
说明
- 若需修改原白名单的 IP 地址，直接输入原白名单的名称即可。您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单名称。
- 若需修改白名单名称，直接输入新的白名单名称即可。名称需同时满足如下要求：
- 不能以数字、中划线（-）开头。
- 只能包含中文、字母、数字、下划线（_）和中划线（-）。
- 长度需为 1~128 个字符。
AllowListDesc String 可选 示例值：test
白名单的备注信息，长度不可超过 200 个字符。
说明
- 若不设置该参数，默认会清空白名单原有的备注信息。
- 若您需要保留白名单原有的备注信息，建议复制原备注信息作为 AllowListDesc 的参数值。
- 例如，白名单的原备注信息为 test-desc，您需要保留该备注信息，那么在调用 ModifyAllowList 接口修改白名单时，需要在请求参数中设置 "AllowListDesc": "test-desc"。
AllowList String 可选 示例值：192.168.0.1
输入 IP 地址或 CIDR 格式的 IP 地址段。
说明
- 若该参数不填，默认不对当前白名单的 IP 地址做任何修改。
- 每个白名单中最多支持设置 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
- 不允许设置重复的地址，多个地址间用英文逗号（,）隔开。
- 设置 0.0.0.0/0，表示允许所有地址访问。
- 设置 127.0.0.1，表示禁止所有地址访问。
- 同时设置 0.0.0.0/0 和 127.0.0.1，表示允许所有地址访问。
- 设置 CIDR 192.168.1.0/24，表示允许该网段内的 IP 地址访问。
- 设置 192.168.1.1，表示仅允许该 IP 地址访问。
ModifyMode String 可选 示例值：Cover
修改方式，取值范围如下：
- Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。
- Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。
- Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
ApplyInstanceNum Long 可选 示例值：1
当前白名单所绑定的实例个数。
说明
- 当需要修改 AllowList 参数时，该参数必填。
- 该参数传入的值必须与当前白名单所绑定的实例个数一致，否则调用该接口时会报错。
- 您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单下绑定的实例总数（即返回参数中 AssociatedInstanceNum的参数值）。
AllowListCategory String 可选 示例值：Default
白名单类型。取值范围如下：
- Ordinary（默认值）：普通白名单。
- Default：默认白名单。
说明
返回参数
示例
请求示例
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=ModifyAllowList&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=****
{
"AllowListId":"acl-04908986ad034ac0ba1fb1e3a754****",
"AllowListName":"test",
"AllowList":"192.168.0.1",
"ApplyInstanceNum":1
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2022031913012601022509900809B309B3",
"Action": "ModifyAllowList",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
错误码
最近更新时间：2026.06.17 16:51:24
这个页面对您有帮助吗？
有用
有用
无用
无用