All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeReplicaSetRole

    Document Center

    ApsaraDB for MongoDB:DescribeReplicaSetRole

    Last Updated:Jan 17, 2023

    You can call this operation to query the role and connection information of an ApsaraDB for MongoDB instance.

    Operation Description

    This operation is applicable to replica set instances and standalone instances, but not to sharded cluster instances.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    dds:DescribeReplicaSetRole READ
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    DBInstanceId string Yes

    The ID of the instance.

    		 dds-bpxxxxxxxx

    Response parameters

    Parameter Type Description Example
    object
    RequestId string

    The ID of the request.

    		 DB4A0595-FCA9-437F-B2BB-25DBFC009D3E
    DBInstanceId string

    The ID of the instance.

    		 dds-bpxxxxxxxx
    ReplicaSets array

    Details about the replica set roles.
    object
    ConnectionPort string

    The port of the node.

    		 3717
    ReplicaSetRole string

    The role of the node in the replica set.

    • Primary
    • Secondary
    		 Primary
    ExpiredTime string

    The remaining duration of the classic network endpoint. Unit: seconds.

    		 1209582
    ConnectionDomain string

    The endpoint of the node.

    		 dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
    NetworkType string

    The network type. Valid values:

    • VPC
    • Classic
    • Public
    		 VPC
    RoleId string

    The role ID of the node.

    		 651xxxxx

    Example

    Normal return example

    JSONFormat

    {
  "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"
      }
    ]
  }
}

    Error codes

    For a list of error codes, visit the API error center.