You need to enable JavaScript to run this app.
文档中心
文档数据库 MongoDB 版

文档数据库 MongoDB 版

复制全文
下载 pdf
白名单管理
DescribeAllowListDetail
复制全文
下载 pdf
DescribeAllowListDetail
调用 DescribeAllowListDetail 接口查询目标白名单的详细信息,包括 IP 地址和绑定的实例详情。​
请求类型​
同步请求。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
AllowListId String 必选 示例值:acl-6c95b7ada03143778ce6978455ca5645​
白名单 ID。​
说明​
您可以调用 DescribeAllowLists接口查询指定地域下所有的白名单列表信息,包括白名单 ID。​
​
​
返回参数​
AllowListId String 示例值:acl-6c95b7ada03143778ce6978455ca5645​
白名单 ID。​
​
AllowListName String 示例值:ecs_ip​
白名单名称。​
​
AllowListDesc String 示例值:test​
白名单的备注。​
​
AllowListType String 示例值:IPv4​
白名单内的 IP 地址类型。当前仅支持 IPv4 地址。​
​
AllowList String 示例值:10.1.***.***,10.2.***.***/24​
白名单内的 IP 地址列表。​
​
AssociatedInstances Object[] 示例值:​
已绑定当前白名单的实例信息。​
VPC String 示例值:vpc-2743n1ihbxla87fap8tap****​
实例所属的私有网络 ID。​
​
InstanceId String 示例值:mongo-replica-e405f8e2****​
已绑定当前白名单的实例 ID。​
​
InstanceName String 示例值:test​
已绑定当前白名单的实例名称。​
​
ProjectName String 示例值:default​
实例所属的项目。​
​
​
ProjectName String 示例值:default​
当前白名单所属的项目。​
​
AllowListCategory String 示例值:Default​
白名单类型。取值范围如下:​
  • Ordinary:普通白名单。​
  • Default:默认白名单。​
​
​
示例​
请求示例​
​
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeAllowListDetail&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-6c95b7ada03143778ce6978455ca5645"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2022031615072601022524311800880088",​
"Action": "DescribeAllowListDetail",​
"Version": "2022-01-01",​
"Service": "mongodb",​
"Region": "cn-beijing"​
},​
"Result": {​
"AllowList": "10.1.***.***,10.2.***.***/24",​
"AllowListDesc": "test",​
"AllowListId": "acl-6c95b7ada03143778ce6978455ca5645",​
"AllowListName": "ecs_ip",​
"AllowListType": "IPv4",​
"AssociatedInstances": [​
{​
"InstanceId": "mongo-replica-e405f8e2f8e2",​
"InstanceName": "test",​
"ProjectName": "default",​
"VPC": "vpc-3tgjebmlgq4e8i4m8i4m" ​
}​
],​
"ProjectName": "default",​
"AllowListCategory": "Default"​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.06.17 16:51:16
这个页面对您有帮助吗?
有用
有用
无用
无用