All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeRoleZoneInfo

Last Updated:Mar 15, 2024

Queries the role and zone of each node in an ApsaraDB for MongoDB instance.

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, but cannot be performed on standalone instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:DescribeRoleZoneInfoREAD
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

dds-bpxxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

728B9A96-E262-4AE5-915E-3A51CCE2FDA9
ZoneInfosobject []

The information of nodes in the zone.

InsNamestring

The ID of the node.

dds-bpxxxxxxxx
NodeTypestring

The type of the node. Valid values:

  • normal
  • configServer
  • shard
  • mongos
Note Valid value for replica set instances: normal. Valid values for sharded cluster instances: configServer, shard, and mongos.
normal
RoleTypestring

The role of the node. Valid values:

  • Primary
  • Secondary
  • Hidden
Primary
ZoneIdstring

The zone ID of the node.

cn-hangzhou-e
RoleIdstring

The role ID.

83xxxxx

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history