文档数据库 MongoDB 版
文档数据库 MongoDB 版
文档指南
请输入
- 文档首页
文档数据库 MongoDB 版API 参考连接管理DeleteDBEndpoint
复制全文
下载 pdfDeleteDBEndpoint
文档反馈
问问助手调用 DeleteDBEndpoint 接口删除目标 MongoDB 实例中指定的连接地址。
请求类型
异步请求。
注意事项
- 私网地址释放成功后，Shard 或 ConfigServer 中所有节点（默认包含 3 个节点）的连接地址均会被释放，且无法继续通过该地址连接到该节点，请谨慎操作。
- MongoDB 实例类型不同，支持申请或释放的连接地址类型也不同。更多信息，请参见连接地址类型。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
InstanceId String 必选 示例值：mongo-shard-011d2479****
实例 ID。
说明
EndpointId String 必选 示例值：V0tAA0hFUENIV00SSg****
连接地址 ID。
说明
- 您可以调用 DescribeDBEndpoint 接口查询目标实例下的连接地址信息，包括连接地址 ID。
- 仅支持释放 MongoDB 分片集群实例中的 Shard 或 ConfigServer 节点的地址，副本集实例或分片集群实例中 Mongos 节点的私网地址是默认提供的，不支持释放。
MongosNodeIds String[] 可选 示例值：["mongo-shard-9a554522****-0","mongo-shard-9a554522****-1"]
需要释放公网连接地址的 Mongos 节点 ID。
说明
- 仅当释放分片集群实例中 Mongos 节点的公网地址时，该参数必填。
- 支持同时释放多个 Mongos 节点的公网地址，多个 Mongos 节点 ID 间用英文逗号（,）分隔。
- 您可以调用 DescribeDBEndpoint接口查询目标实例分片集群实例下所有 Mongos 节点的连接信息，包括 Mongos 的节点 ID。
返回参数
示例
请求示例 1
释放副本集实例的公网地址。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DeleteDBEndpoint&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=****
{
"InstanceId":"mongo-replica-617a883d****",
"EndpointId":"UUtGBkJJVB5EBE****"
}
返回示例 1
{
"ResponseMetadata": {
"RequestId": "202203141832270102120352320B0D0B0D",
"Action": "DeleteDBEndpoint",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
请求示例 2
释放分片集群实例中 Configserver 节点或 Shard 分片的私网地址。
说明
释放私网地址前需先释放对应节点的公网地址。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DeleteDBEndpoint&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=****
{
"InstanceId":"mongo-shard-9a554522****",
"EndpointId":"XhtEUk5EVUhEVkNCSg****"
}
返回示例 2
{
"ResponseMetadata": {
"RequestId": "202203141832270102120352320B0D0B0D",
"Action": "DeleteDBEndpoint",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
请求示例 3
释放分片集群实例中两个 Mongos 节点的公网地址。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DeleteDBEndpoint&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=****
{
"InstanceId": "mongo-shard-9a554522****",
"EndpointId": "XhtEUk5EVUhEVk****",
"MongosNodeIds": [
"mongo-shard-9a554522****-0",
"mongo-shard-9a554522****-1"
]
}
返回示例 3
{
"ResponseMetadata": {
"RequestId": "202203141832270102120352320B0D0B0D",
"Action": "DeleteDBEndpoint",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
错误码
最近更新时间：2026.06.17 16:16:44
这个页面对您有帮助吗？
有用
有用
无用
无用