All Products
Document Center


Last Updated: Dec 08, 2017


This API supports sharded cluster instances only.

Request parameters

NameTypeRequired or notDescription
ActionStringYesRequired parameter; value: DescribeShardingNetworkAddress.
DBInstanceIdStringYesSharding logic instance name
NoIdStringNo- Input the ApsaraDB for Mongos ID of the sharding instance.
- If this parameter is left blank, connection information about all Mongos under the sharding is returned.

Response parameters

Public response parameters-See public response parameters.
NetworkAddressesList<NetworkAddress>Information of the instance connection address


Public response parametersSee public response parameters.
NetworkAddressStringDNS connection string
IPAddressStringIP address
NetworkTypeString- VPC: Connection address of a private network
- Classic: Connection address of a classic network
- Public: Connection address of a public network
VPCIdStringVPC ID, which is returned for VPC addresses.
VswitchIdStringVSwitch ID, which is returned for VPC addresses.
NodeIdStringIf the parameter is set to sharding, the corresponding node ID (Mongos ID) is returned.
ExpiredTimeStringRemaining duration of the classic network address, in seconds.