白名单分组管理
更新时间:2026-09-23
白名单分组用于将多个访问 IP 组织成可复用的分组,便于按业务环境或网络范围管理 MongoDB 实例访问控制。不同分组之间允许出现相同 IP。
本文包含以下接口:
- 创建白名单分组
- 更新白名单分组
- 删除白名单分组
- 查询白名单分组列表
注意事项
- 所有接口都要求传入实例 ID,并对实例进行资源级权限校验。
- 创建、更新、删除需要
OPERATE权限;查询需要READ或OPERATE权限。 - IP 支持单个 IPv4 地址和 CIDR 网段,具体格式以服务端校验结果为准。
- 删除分组不会删除实例其他来源(直接 IP、安全组、IP 模板)的白名单。
费用说明
白名单分组管理接口本身不产生额外费用。实例资源及网络相关费用以 MongoDB 产品计费规则为准。
1. 创建白名单分组
请求结构
Text
1POST /v1/api/mongo/instance/{instanceId}/securityIpGroup HTTP/1.1
2Host: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | URL 参数 | 实例 ID。 |
| name | String | 是 | 请求 Body | 分组名称,例如“测试分组”“生产分组”。 |
| ips | Arraystring | 是 | 请求 Body | IP 地址列表,支持 IPv4 和 CIDR 网段。 |
请求示例
JSON
1POST /v1/api/mongo/instance/m-i5hAjk/securityIpGroup HTTP/1.1
2Host: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
5
6{
7 "name": "test",
8 "ips": ["10.236.48.5", "192.168.1.0/24"]
9}
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Boolean | 创建是否成功。 |
返回示例
JSON
1{
2 "result": true
3}
2. 更新白名单分组
请求结构
Text
1PUT /v1/api/mongo/instance/{instanceId}/securityIpGroup/{uuid} HTTP/1.1
2Host: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | URL 参数 | 实例 ID。 |
| uuid | String | 是 | URL 参数 | 白名单分组唯一标识。 |
| name | String | 是 | 请求 Body | 更新后的分组名称。 |
| ips | Arraystring | 是 | 请求 Body | 更新后的完整 IP 列表;传空数组表示清空分组 IP。 |
请求示例
JSON
1PUT /v1/api/mongo/instance/m-i5hAjk/securityIpGroup/d50467ad-4afd-46ac-98a2-542e894866e9 HTTP/1.1
2Host: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
5
6{
7 "name": "test",
8 "ips": []
9}
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Boolean | 更新是否成功。 |
返回示例
JSON
1{
2 "result": true
3}
3. 删除白名单分组
请求结构
Text
1DELETE /v1/api/mongo/instance/{instanceId}/securityIpGroup/{uuid} HTTP/1.1
2Host: mongodb.bj.baidubce.com
3Authorization: authorization string
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | URL 参数 | 实例 ID。 |
| uuid | String | 是 | URL 参数 | 白名单分组唯一标识。 |
请求示例
Text
1DELETE /v1/api/mongo/instance/m-i5hAjk/securityIpGroup/d50467ad-4afd-46ac-98a2-542e894866e9 HTTP/1.1
2Host: mongodb.bj.baidubce.com
3Authorization: authorization string
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Boolean | 删除是否成功。 |
返回示例
JSON
1{
2 "result": true
3}
4. 查询白名单分组列表
请求结构
Text
1GET /v1/api/mongo/instance/{instanceId}/securityIpGroup HTTP/1.1
2Host: mongodb.bj.baidubce.com
3Authorization: authorization string
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | URL 参数 | 实例 ID。 |
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Object | 白名单分组查询结果。 |
| result.groups | Array | |
| 分组列表。 | ||
| result.groups[].uuid | String | 分组唯一标识。 |
| result.groups[].name | String | 分组名称。 |
| result.groups[].status | String | 分组状态。 |
| result.groups[].ips | Array |
分组 IP 列表。 |
请求示例
Text
1GET /v1/api/mongo/instance/m-i5hAjk/securityIpGroup HTTP/1.1
2Host: mongodb.bj.baidubce.com
3Authorization: authorization string
返回示例
JSON
1{
2 "result": {
3 "groups": [
4 {
5 "uuid": "d50467ad-4afd-46ac-98a2-542e894866e9",
6 "name": "test",
7 "status": "INUSE",
8 "ips": ["10.236.48.5"]
9 }
10 ]
11 }
12}
评价此篇文章
