调用DescribeShardingNetworkAddress接口查询MongoDB分片集群实例的连接信息。
该接口仅支持分片集群实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeShardingNetworkAddress |
要执行的操作,取值:DescribeShardingNetworkAddress。 |
DBInstanceId | String | 是 | dds-bpxxxxxxxx |
实例ID。 |
NodeId | String | 否 | d-bpxxxxxxxx |
分片集群实例中Mongos节点ID、Shard节点ID或ConfigServer节点ID。 说明 您可以调用DescribeDBInstanceAttribute接口查询Mongos/Shard/ConfigServer节点ID。
|
RegionId | String | 否 | cn-hangzhou |
地域ID,您可以调用DescribeRegions查询。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CompatibleConnections | Array |
DynamoDB协议类型实例的连接地址信息列表。 |
|
CompatibleConnection | |||
ExpiredTime | String | 2591963 |
保留的经典网络地址剩余时长,单位为秒。 |
IPAddress | String | 10.140.xxx.xx |
IP地址。 |
NetworkAddress | String | dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com |
连接地址。 |
NetworkType | String | VPC |
网络类型。
|
Port | String | 3717 |
连接端口。 |
VPCId | String | vpc-bpxxxxxxxx |
专有网络ID。 说明 当网络类型为VPC时返回该参数。
|
VswitchId | String | vsw-bpxxxxxxxx |
专有网络中交换机ID。 说明 当网络类型为VPC时返回该参数。
|
NetworkAddresses | Array |
MongoDB协议类型实例的连接地址信息列表。 |
|
NetworkAddress | |||
ExpiredTime | String | 2591963 |
保留的经典网络地址剩余时长,单位为秒。 |
IPAddress | String | 10.140.xxx.xx |
IP地址。 |
NetworkAddress | String | s-bpxxxxxxxx.mongodb.rds.aliyuncs.com |
连接地址(字符串)。 |
NetworkType | String | VPC |
网络类型。
|
NodeId | String | s-bpxxxxxxxx |
Mongos节点ID。 |
NodeType | String | mongos |
节点类型,返回值为
|
Port | String | 3717 |
连接端口。 |
Role | String | Primary |
节点角色,返回值:
|
VPCId | String | vpc-bpxxxxxxxx |
专有网络ID。 说明 当网络类型为VPC时返回该参数。
|
VswitchId | String | vsw-bpxxxxxxxx |
专有网络中交换机ID。 说明 当网络类型为VPC时返回该参数。
|
RequestId | String | 18D8AAFD-6BEB-420F-8164-810CB0C0AA39 |
请求ID。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=DescribeShardingNetworkAddress
&DBInstanceId=dds-bpxxxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<NetworkAddresses>
<NetworkAddress>
<NetworkType>Public</NetworkType>
<NodeId>s-bpxxxxxxxx</NodeId>
<Port>3717</Port>
<VPCId/>
<IPAddress>47.xx.xx.xxx</IPAddress>
<NodeType>mongos</NodeType>
<Role>Primary</Role>
<NetworkAddress>s-bpxxxxxxxx-pub.mongodb.rds.aliyuncs.com</NetworkAddress>
</NetworkAddress>
<NetworkAddress>
<NetworkType>VPC</NetworkType>
<NodeId>s-bpxxxxxxxx</NodeId>
<Port>3717</Port>
<VPCId>vpc-bpxxxxxxxx</VPCId>
<IPAddress>192.168.xx.xxx</IPAddress>
<NodeType>mongos</NodeType>
<Role>Primary</Role>
<VswitchId>vsw-bpxxxxxxxx</VswitchId>
<NetworkAddress>s-bpxxxxxxxx.mongodb.rds.aliyuncs.com</NetworkAddress>
</NetworkAddress>
</NetworkAddresses>
<RequestId>3F5DD5CD-0B93-46FF-96DD-F938B13CDE8B</RequestId>
JSON
格式
{
"NetworkAddresses": {
"NetworkAddress": [
{
"NetworkType": "Public",
"NodeId": "s-bpxxxxxxxx",
"Port": "3717",
"VPCId": "",
"IPAddress": "47.xx.xx.xxx",
"NodeType": "mongos",
"Role": "Primary",
"NetworkAddress": "s-bpxxxxxxxx-pub.mongodb.rds.aliyuncs.com"
},
{
"NetworkType": "VPC",
"NodeId": "s-bpxxxxxxxx",
"Port": "3717",
"VPCId": "vpc-bpxxxxxxxx",
"IPAddress": "192.168.xx.xxx",
"NodeType": "mongos",
"Role": "Primary",
"VswitchId": "vsw-bpxxxxxxxx",
"NetworkAddress": "s-bpxxxxxxxx.mongodb.rds.aliyuncs.com"
}
]
},
"RequestId": "3F5DD5CD-0B93-46FF-96DD-F938B13CDE8B"
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交