DescribeAccounts - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation Description

Note This operation can query only the information of the root account.

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:DescribeAccounts	LIST	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-bp1fd530f271****
AccountName	string	No	The name of the account. Set the value to root.	root

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	B562A65B-39AB-4EE8-8635-5A222054FB35
Accounts	array	Details about the accounts.
	object
CharacterType	string	The role of the account. Valid values: db: shard cs: Configserver mongos: mongos logic: sharded cluster instance normal: replica set instance	mongos
AccountStatus	string	The status of the account. Unavailable Available	Available
AccountDescription	string	The description of the account.
DBInstanceId	string	The name of the instance to which the account belongs.	dds-bp1fd530f271****
AccountName	string	The name of the account.	root

Example

Normal return example

JSONFormat

{
  "RequestId": "B562A65B-39AB-4EE8-8635-5A222054FB35",
  "Accounts": {
    "Account": [
      {
        "CharacterType": "mongos",
        "AccountStatus": "Available",
        "AccountDescription": "",
        "DBInstanceId": "dds-bp1fd530f271****",
        "AccountName": "root"
      }
    ]
  }
}

Error codes

Http code	Error code	Error message
403	ResponseEmptyError	The Response is empty, maybe server request timeout.

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