DescribeShardingNetworkAddress API Overview - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Retrieves the connection information for a MongoDB sharded cluster instance.

Operation description

This API is for sharded cluster instances only.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeShardingNetworkAddress

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bpxxxxxxxx
NodeId	string	No	The ID of a mongos, shard, or ConfigServer node in the sharded cluster instance. Note You can call the DescribeDBInstanceAttribute operation to query the IDs of mongos, shard, and ConfigServer nodes.	d-bpxxxxxxxx
NetworkType	string	No	The network type. Valid values: VPC: virtual private cloud. Classic: classic network. Public: public network.	VPC

Response elements

Element	Type	Description	Example
	object
CompatibleConnections	object
CompatibleConnection	array<object>	Connection details for instances compatible with the DynamoDB protocol.
	object
VswitchId	string	The ID of the vSwitch in the VPC. Note This parameter is returned only when the network type is VPC.	vsw-bpxxxxxxxx
ExpiredTime	string	The remaining validity period of the classic network address that is retained, in seconds.	2591963
NetworkType	string	The network type. Valid values: VPC: a virtual private cloud. Classic: classic network. Public: public network.	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. Note This parameter is returned only 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	object
NetworkAddress	array<object>	Connection details for instances that use the MongoDB protocol.
	object
NodeType	string	The type of the node. Valid values: mongos: a mongos node. shard: a shard node. configserver: a config server node.	mongos
VswitchId	string	The ID of the vSwitch in the VPC. Note This parameter is returned only when the network type is VPC.	vsw-bpxxxxxxxx
ExpiredTime	string	The remaining validity period of the classic network address that is retained, in seconds.	2591963
NetworkType	string	The network type. Valid values: VPC: a virtual private cloud. Classic: classic network. Public: public network.	VPC
Role	string	The role of the node. Valid values: Primary: a primary node. Secondary: secondary node.	Primary
Port	string	The port that is used to connect to the instance.	3717
VPCId	string	The VPC ID. Note This parameter is returned only when the network type is VPC.	vpc-bpxxxxxxxx
NetworkAddress	string	The endpoint of the node.	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NodeId	string	The ID of the mongos or shard node.	s-bpxxxxxxxx
IPAddress	string	The IP address of the node.	10.140.xxx.xx
ConnectionType	string	The type of the public endpoint. Valid values: SRV Normal	SRV
TxtRecord	string	The TXT record. A TXT record is a type of Domain Name System (DNS) record that is used to store text-based information about a domain. It can be used to deliver service configurations and discover services by working with other technologies such as SRV records.	mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"
ConnectionStringSuffix	string	The suffix of the connection string.	.mongodb.rds.aliyuncs.com

Examples

Success response

JSON format

{
  "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\""
      }
    ]
  },
  "ConnectionStringSuffix": ".mongodb.rds.aliyuncs.com"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.