Node Roles and Zone Distribution in MongoDB Clusters - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Operation description

Note

For more information, see View the zone of a node.

This operation is applicable to replica set instances and sharded cluster instances. Standalone instances are not supported.

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

get

*dbinstance

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
RequestId	string	The request ID.	728B9A96-E262-4AE5-915E-3A51CCE2FDA9
ZoneInfos	object
ZoneInfo	array<object>	The list of node distribution information across zones.
	object
InsName	string	The node ID.	dds-bpxxxxxxxx
NodeType	string	The node type. Valid values: normal: regular node configServer: config server node shard: shard node mongos: mongos node Note If the instance is a replica set instance, the return value is normal. If the instance is a sharded cluster instance, the return values include configServer, shard, and mongos.	normal
RoleType	string	The role of the node. Valid values: Primary: primary node Secondary: secondary node Hidden: hidden node	Primary
ZoneId	string	The zone ID.	cn-hangzhou-e
RoleId	string	The role ID.	83xxxxx

Examples

Success response

JSON format

{
  "RequestId": "728B9A96-E262-4AE5-915E-3A51CCE2FDA9",
  "ZoneInfos": {
    "ZoneInfo": [
      {
        "InsName": "dds-bpxxxxxxxx",
        "NodeType": "normal",
        "RoleType": "Primary",
        "ZoneId": "cn-hangzhou-e",
        "RoleId": "83xxxxx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.