DescribeDBEndpoint

调用 DescribeDBEndpoint 接口查询目标实例下的连接地址信息。

请求类型

同步请求。

注意事项

调用 DescribeDBEndpoint 接口查询实例连接地址信息时，会同时返回连接地址的域名和IP地址信息。但不建议使用 IP:port 的方式来连接实例，因为切换子网后 IP 地址会改变，客户端代码如果没有及时更新则会出现实例连接失败的问题。
建议您使用 域名:port 的方式来访问 MongoDB 实例，避免出现因 IP 地址改变导致实例无法连接的问题。连接 MongoDB 实例的具体步骤，请参见通过 Mongo Shell 工具连接实例。

请求参数

返回数据

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeDBEndpoint&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-617a883d5****"
}

返回示例

正常返回示例

• 副本集实例返回结果。

  {
      "ResponseMetadata": {
          "RequestId": "202205281742120102250821990282****",
          "Action": "DescribeDBEndpoint",
          "Version": "2022-01-01",
          "Service": "mongodb",
          "Region": "cn-beijing"
      },
      "Result": {
         "DBEndpoints": [
             {
                 "DBAddresses": [
                     {
                        "AddressDomain": "mongoreplica617a883d5****.mongodb.ivolces.com",
                        "AddressIP": "192.168.***.***",
                        "AddressPort": "3717",
                        "AddressType": "Primary",
                        "EipId": "",
                        "NodeId": "mongo-replica-617a883d5****-0"
                     },
                     {
                        "AddressDomain": "mongoreplica617a883d5****.mongodb.ivolces.com",
                        "AddressIP": "192.168.***.***",
                        "AddressPort": "3717",
                        "AddressType": "Secondary",
                        "EipId": "",
                        "NodeId": "mongo-replica-617a883d5****-1"
                    },
                    {
                        "AddressDomain": "mongoreplica617a883d5****2.mongodb.ivolces.com",
                        "AddressIP": "192.168.***.***",
                        "AddressPort": "3717",
                        "AddressType": "Hidden",
                        "EipId": "",
  "NodeId": "mongo-replica-617a883d5****-2"
                    }
                ],
                "EndpointId": "UUtGBkJJVB5EBE****",
                "EndpointStr": "mongodb://<user>:<password>@mongoreplica617a883d5****.mongodb.ivolces.com:3717,mongoreplica617a883d5****.mongodb.ivolces.com:3717/?authSource=admin&replicaSet=rs-mongo-replica-617a883d5****&retryWrites=true",
                "EndpointType": "ReplicaSet",
                "NetworkType": "Private",
                "SubnetId": "subnet-3rfc6bfv8lssg5zsk2h7z****",
                "VpcId": "vpc-2bzrc4aszyg3k2dx0eeic****"
              },
              {
                "DBAddresses": [
                    {
                        "AddressDomain": "mongoreplica617a883d5****.mongodb.volces.com",
                        "AddressIP": "10.249.***.***",
                        "AddressPort": "3717",
                        "AddressType": "Primary",
                        "EipId": "eip-2d744t595x6o058ozfeht****",
                        "NodeId": "mongo-replica-617a883d5****-0"
                    },
                    {
                        "AddressDomain": "mongoreplica617a883d5****.mongodb.volces.com",
                        "AddressIP": "10.249.***.***",
                        "AddressPort": "3717",
                        "AddressType": "Secondary",
                        "EipId": "eip-2d6v5hyyvu4g058ozfeai****",
                        "NodeId": "mongo-replica-617a883d5****-1"
                    }
                ],
                "EndpointId": "UUtGBkJJVB5EBE****",
                "EndpointStr": "mongodb://<user>:<password>@mongoreplica617a883d5****.mongodb.volces.com:3717,mongoreplica617a883d5****.mongodb.volces.com:3717/?authSource=admin&replicaSet=rs-mongo-replica-617a883d5****&retryWrites=true",
                "EndpointType": "ReplicaSet",
                "NetworkType": "Public",
                "SubnetId": "subnet-3rfc6bfv8lssg5zsk2h7z****",
                "VpcId": "vpc-2bzrc4aszyg3k2dx0eeic****"
                }
              ]
      }
  }
  

• 分片集群实例返回结果。

  {
       "ResponseMetadata": {
           "RequestId": "202205281742120102250821990282****",
           "Action": "DescribeDBEndpoint",
           "Version": "2022-01-01",
           "Service": "mongodb",
           "Region": "cn-beijing"
       },
       "Result": {
          "DBEndpoints": [
              {
                "DBAddresses": [
                    {
                       "AddressDomain": "mongoshard9a5545225****.mongodb.ivolces.com",
                       "AddressIP": "192.168.***.***",
                       "AddressPort": "3717",
                       "AddressType": "Primary",
                       "EipId": "",
                       "NodeId": "mongo-shard-9a5545225****-0"
                    },
                    {
                       "AddressDomain": "mongoshard9a5545225****1.mongodb.ivolces.com",
                       "AddressIP": "192.168.***.***",
                       "AddressPort": "3717",
                       "AddressType": "Primary",
                       "EipId": "",
                       "NodeId": "mongo-shard-9a5545225****-1"
                    }
                ],
                "EndpointId": "XhtEUk5EVUhEVk****",
                "EndpointStr": "mongodb://<user>:<password>@mongoshard9a5545225****.mongodb.ivolces.com:3717,mongoshard9a5545225****1.mongodb.ivolces.com:3717/?authSource=admin&connect=direct&retryWrites=true",
                "EndpointType": "Mongos",
                "NetworkType": "Private",
                "ObjectId": "mongo-shard-9a5545225****",
                "SubnetId": "subnet-3rfc6bfv8lssg5zsk2h7z****",
                "VpcId": "vpc-2bzrc4aszyg3k2dx0eeic****"
              }
          ]
       }
   }