You need to enable JavaScript to run this app.
导航

DeleteDBEndpoint

最近更新时间2023.03.14 20:29:41

首次发布时间2022.04.12 11:06:53

调用 DeleteDBEndpoint 接口删除目标实例的连接地址。

注意事项

  • 私网地址释放成功后,Shard 或 ConfigServer 中所有节点(默认包含 3 个节点)的连接地址均会被释放,且无法继续通过该地址连接到该节点,请谨慎操作。
  • MongoDB 实例类型不同,支持申请或释放的连接地址类型也不同。更多信息,请参见连接地址类型

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述

InstanceId

String

mongo-shard-011d2479****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。

EndpointId

String

V0tAA0hFUENIV00SSg****

连接地址 ID。

说明

  • 您可以调用 DescribeDBEndpoint 接口查询目标实例下的连接地址信息,包括连接地址 ID。
  • 仅支持释放 MongoDB 分片集群实例中的 Shard 或 ConfigServer 节点的地址,副本集实例或分片集群实例中 Mongos 节点的私网地址是默认提供的,不支持释放。

MongosNodeIds

Array of String

["mongo-shard-9a554522****-0","mongo-shard-9a554522****-1"]

需要释放公网连接地址的 Mongos 节点 ID。

说明

  • 仅当释放分片集群实例中 Mongos 节点的公网地址时,该参数必填。
  • 支持同时释放多个 Mongos 节点的公网地址,多个 Mongos 节点 ID 间用英文逗号(,)分隔。
  • 您可以调用 DescribeDBEndpoint 接口查询目标实例分片集群实例下所有 Mongos 节点的连接信息,包括 Mongos 的节点 ID。

返回数据

null

请求示例

  • 释放副本集实例的公网地址。

    POST https://mongodb.volcengineapi.com/?Action=DeleteDBEndpoint&Version=2022-01-01 HTTP/1.1
    Host: mongodb.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****"
    }
    
  • 释放分片集群实例中 Configserver 节点或 Shard 分片的私网地址。

    说明

    释放私网地址前需先释放对应节点的公网地址。

    POST https://mongodb.volcengineapi.com/?Action=DeleteDBEndpoint&Version=2022-01-01 HTTP/1.1
    Host: mongodb.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****"
    }
    
  • 释放分片集群实例中两个 Mongos 节点的公网地址。

    POST https://mongodb.volcengineapi.com/?Action=DeleteDBEndpoint&Version=2022-01-01 HTTP/1.1
    Host: mongodb.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"
      ]
    }
    

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202203141832270102120352320B0D****",
        "Action": "DeleteDBEndpoint",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
 "Result": null
}