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

请求类型

同步请求。

注意事项

调用 DescribeDBEndpoint 接口查询实例连接地址信息时，会同时返回连接地址的域名和IP地址信息。但不建议使用 IP:port 的方式来连接实例，因为切换子网后 IP 地址会改变，客户端代码如果没有及时更新则会出现实例连接失败的问题。

建议您使用域名:port 的方式来访问 MongoDB 实例，避免出现因 IP 地址改变导致实例无法连接的问题。连接 MongoDB 实例的具体步骤，请参见通过 Mongo Shell 工具连接实例。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

InstanceId String 必选示例值：mongo-replica-617a883d583d5

实例 ID。

说明

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

返回参数

DBEndpoints Object[] 示例值：

连接地址信息列表。

DBAddresses Object[]

连接地址串信息列表。

AddressDomain String 示例值：mongoreplicae405f8e2c****.mongodb.ivolces.com

连接地址的域名。

AddressIP String 示例值：192.168.\*\*\*.\*\*\*

连接地址所对应的 IP。

说明

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

AddressPort String 示例值：3717

连接地址的端口号。

AddressType String 示例值：Primary

节点的连接地址类型，取值范围如下：

Primary：主节点连接地址。

Secondary：从节点连接地址。

Hidden：隐藏节点连接地址。

ReadOnly：只读节点连接地址。

说明

仅当连接地址类型为私网连接地址（即 NetworkType 取值为 Private）时，会返回隐藏节点或只读节点的连接地址信息。

仅当副本集实例中存在只读节点时，才会返回只读节点的连接地址信息。分片集群实例 Shard 分片中即使存在只读节点，也不会展示只读节点相关信息。更多关于只读节点的信息，请参见管理只读节点。

EipId String 示例值：eip-2fef2qcfbfw8w5oxruw3w****

实例公网地址所绑定的 EIP ID。

说明

仅当连接地址类型为公网连接地址（即 NetworkType 取值为 Public）时，返回该参数。

NodeId String 示例值：mongo-shard-9a554522****-1

连接地址所属的节点 ID。

EndpointId String 示例值：Ak5BUhxJAkgSVR****

连接地址 ID。

EndpointStr String 示例值：mongodb://<user>:<password>@mongoreplicae405f8e2c****.mongodb.ivolces.com:3717,mongoreplicae405f8e2c****.mongodb.ivolces.com:3717/?authSource=admin&replicaSet=rs-mongo-replica-e405f8e2****&retryWrites=true

连接地址的字符串信息。

EndpointType String 示例值：RelicaSet

连接地址所对应的节点类型。取值范围如下：

副本集实例仅支持 ReplicaSet（即副本集）连接地址类型。

分片集群实例支持 Mongos（即 Mongos 节点）、ConfigServer（即 ConfigServer 节点）和 Shard（即 Shard 节点）三种连接地址类型。

NetworkType String 示例值：Private

连接地址的网络类型，取值范围如下：

Private：私网连接地址。

Public：公网连接地址。

ObjectId String 示例值：mongo-shard-cd807041****

当前连接地址所属组件的 ID。

说明

仅当 EndpointType 取值为 Mongos、ConfigServer 或 Shard时，会返回该参数。

VpcId String 示例值：vpc-3tjjjskc6p4d2et2****

当前实例所属的私有网络 ID。

SubnetId String 示例值：subnet-3rfc6bfv8lssg5zsk2h7z****

当前实例所属的子网 ID。

示例

请求示例 1

查询副本集实例的连接地址详情。

返回示例 1

副本集实例返回结果。

如下示例仅展示了实例中部分节点的连接地址信息，具体返回数据以接口调用的实际返回结果为准。

请求示例 2

查询分片集群实例的连接地址信息。

返回示例 2

分片集群实例返回结果。

如下示例仅展示了实例中部分节点的连接地址信息，具体返回数据以接口调用的实际返回结果为准。

错误码

更多详情，请参见错误码。

文档数据库 MongoDB 版