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

Retrieves the role information and connection details for a MongoDB instance.

Operation description

This operation applies to replica set instances and single-node instances. It does not apply to sharded cluster instances.

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:DescribeReplicaSetRole

get

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bpxxxxxxxx

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	DB4A0595-FCA9-437F-B2BB-25DBFC009D3E
DBInstanceId	string	The instance ID.	dds-bpxxxxxxxx
ReplicaSets	object	Details of the replica set.
ReplicaSet	array<object>	A list of nodes in the replica set.
	object	The details of a node.
ConnectionPort	string	The connection port of the node.	3717
ReplicaSetRole	string	The role of the node in the replica set. Primary: primary node. Secondary: secondary node.	Primary
ExpiredTime	string	The remaining time in seconds before the classic network endpoint expires.	1209582
ConnectionDomain	string	The connection endpoint of the node.	dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NetworkType	string	The network type of the endpoint. VPC: virtual private cloud. Classic: classic network. Public: public network.	VPC
RoleId	string	The role ID of the node.	651xxxxx
ConnectionType	string	The connection type.	SRV
ConnectionStringSuffix	string	The domain name suffix for the connection string.	.mongodb.rds.aliyuncs.com

Examples

Success response

JSON format

{
  "RequestId": "DB4A0595-FCA9-437F-B2BB-25DBFC009D3E",
  "DBInstanceId": "dds-bpxxxxxxxx",
  "ReplicaSets": {
    "ReplicaSet": [
      {
        "ConnectionPort": "3717",
        "ReplicaSetRole": "Primary",
        "ExpiredTime": "1209582",
        "ConnectionDomain": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NetworkType": "VPC",
        "RoleId": "651xxxxx",
        "ConnectionType": "SRV"
      }
    ]
  },
  "ConnectionStringSuffix": ".mongodb.rds.aliyuncs.com\n"
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.