DescribeShardingNetworkAddress - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries connection information about an ApsaraDB for MongoDB sharded cluster instance.

Operation description

This operation is applicable only to sharded cluster instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dds:DescribeShardingNetworkAddress	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bpxxxxxxxx
NodeId	string	No	The ID of the mongos, shard, or Configserver node in the sharded cluster instance. Note You can call the DescribeDBInstanceAttribute operation to view the ID of the mongos, shard, or Configserver node.	d-bpxxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object
CompatibleConnections	array<object>	The endpoints of DynamoDB-compatible instances.
CompatibleConnection	object
VswitchId	string	The ID of the vSwitch in the Virtual Private Cloud (VPC). Note This parameter is returned when the network type is VPC.	vsw-bpxxxxxxxx
ExpiredTime	string	The remaining duration of the classic network endpoint. Unit: seconds.	2591963
NetworkType	string	The network type of the instance. VPC: virtual private cloud Classic: classic network Public: the Internet	VPC
Port	string	The port that is used to connect to the instance.	3717
NetworkAddress	string	The endpoint of the instance.	dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com
VPCId	string	The VPC ID of the instance. Note This parameter is returned when the network type is VPC.	vpc-bpxxxxxxxx
IPAddress	string	The IP address of the instance.	10.140.xxx.xx
RequestId	string	The request ID.	18D8AAFD-6BEB-420F-8164-810CB0C0AA39
NetworkAddresses	array<object>	The endpoints of the ApsaraDB for MongoDB sharded cluster instance.
NetworkAddress	object
NodeType	string	The type of the node. Valid values: mongos: mongos node shard: shard node configserver: Configserver node	mongos
VswitchId	string	The ID of the vSwitch in the VPC. Note This parameter is returned when the network type is VPC.	vsw-bpxxxxxxxx
ExpiredTime	string	The remaining duration of the classic network endpoint. Unit: seconds.	2591963
NetworkType	string	The network type of the instance. VPC: virtual private cloud Classic: classic network Public: the Internet	VPC
Role	string	The role of the node. Valid values: Primary Secondary	Primary
Port	string	The port that is used to connect to the instance.	3717
VPCId	string	The VPC ID of the instance. Note This parameter is returned when the network type is VPC.	vpc-bpxxxxxxxx
NetworkAddress	string	The connection string of the instance.	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NodeId	string	The ID of the mongos node.	s-bpxxxxxxxx
IPAddress	string	The IP address of the instance.	10.140.xxx.xx
ConnectionType	string	The public endpoint type. Valid values: SRV Normal	SRV
TxtRecord	string	Txt record which can be used to store MongoDB-related meta data, such as version, configuration parameters and etc. With the combination of txt record and other technology, for example SRV record, the MongoDB client can complete the complex service discovery and configuration passing.	mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"

Examples

Sample success responses

JSONformat

{
  "CompatibleConnections": {
    "CompatibleConnection": [
      {
        "VswitchId": "vsw-bpxxxxxxxx",
        "ExpiredTime": "2591963",
        "NetworkType": "VPC",
        "Port": "3717",
        "NetworkAddress": "dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com",
        "VPCId": "vpc-bpxxxxxxxx",
        "IPAddress": "10.140.xxx.xx"
      }
    ]
  },
  "RequestId": "18D8AAFD-6BEB-420F-8164-810CB0C0AA39",
  "NetworkAddresses": {
    "NetworkAddress": [
      {
        "NodeType": "mongos",
        "VswitchId": "vsw-bpxxxxxxxx",
        "ExpiredTime": "2591963",
        "NetworkType": "VPC",
        "Role": "Primary",
        "Port": "3717",
        "VPCId": "vpc-bpxxxxxxxx",
        "NetworkAddress": "s-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NodeId": "s-bpxxxxxxxx",
        "IPAddress": "10.140.xxx.xx",
        "ConnectionType": "SRV",
        "TxtRecord": "mongo.example.com. IN TXT \"config=replicaSet=myReplicaSet\""
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-22	The response structure of the API has changed	View Change Details