文档数据库 MongoDB 版
文档数据库 MongoDB 版
文档指南
请输入
- 文档首页
文档数据库 MongoDB 版API 参考白名单管理DescribeAllowLists
复制全文
下载 pdfDescribeAllowLists
文档反馈
问问助手调用 DescribeAllowLists 接口查询当前账号下指定地域内的 IP 白名单列表。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
InstanceId String 可选 示例值：mongo-replica-cn014a009e8b9e8b
实例 ID。
说明
ProjectName String 可选 示例值：default
白名单所属的项目。
说明
若该参数留空，表示不使用白名单的项目名称条件进行筛选。
AllowListCategory String 可选 示例值：Default
白名单类型。取值范围如下：
- Ordinary：普通白名单。
- Default：默认白名单。
说明
若该参数留空，表示不使用白名单类型条件进行筛选。
PageSize Long 可选 示例值：1
白名单信息列表的页码。取值为不超过 Integer 数据类型的最大值，起始值为 1。
说明
若该参数留空，表示不使用页码进行筛选。
PageNumber Long 可选 示例值：10
每页记录数，取值范围为 大于等于 1 的整数。
说明
若该参数留空，表示不使用每页记录数进行筛选。
返回参数
AllowLists Object[] 示例值：
白名单信息列表。
AllowListId String 示例值：acl-cdcbb69328cd40b7a9fa5d4c2cf8****
白名单 ID。
AllowListDesc String 示例值：test
白名单的备注。
AllowListName String 示例值：ecs_list
白名单名称。
AllowListType String 示例值：IPv4
白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AllowListIPNum Long 示例值：2
白名单内的 IP 地址（或地址段）总数。
AssociatedInstanceNum Long 示例值：1
白名单下绑定的实例总数。
ProjectName String 示例值：default
白名单所属的项目。
AllowListCategory String 示例值：Default
白名单类型。取值范围如下：
- Ordinary：普通白名单。
- Default：默认白名单。
AccessControlType String
访问控制类型：白名单/黑名单
示例
请求示例
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeAllowLists&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=****
{
"RegionId": "cn-beijing",
"InstanceId": "mongo-replica-cn014a009e8bxxxx"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202211102131170102081741611F78xxxx",
"Action": "DescribeAllowLists",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": {
"AllowLists": [
{
"AllowListDesc": "test",
"AllowListIPNum": 2,
"AllowListId": "acl-cdcbb69328cd40b7a9fa5d4c2cf8xxxx",
"AllowListName": "ecs_list",
"AllowListType": "IPv4",
"AssociatedInstanceNum": 1,
"ProjectName": "default",
"AllowListCategory": "Default"
}
]
}
}
错误码
最近更新时间：2026.07.24 14:04:40
这个页面对您有帮助吗？
有用
有用
无用
无用