DescribeAccounts - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the database accounts of an ApsaraDB for MongoDB instance.

Operation description

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

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:DescribeAccounts	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	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 request ID.	B562A65B-39AB-4EE8-8635-5A222054FB35
Accounts	array<object>	The details of the account.
	object
CharacterType	string	The role of the account. Valid values: db: shard node cs: Configserver node mongos: mongos node logic: sharded cluster instance normal: replica set instance	mongos
AccountStatus	string	The status of the account. Valid values: Unavailable Available	Available
AccountDescription	string	The description of the account.	Admin
DBInstanceId	string	The ID of the instance to which the account belongs.	dds-bp1fd530f271****
AccountName	string	The name of the account.	root

Examples

Sample success responses

JSONformat

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

Error codes

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

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

Change history

Change time	Summary of changes	Operation
2023-03-22	The Error code has changed. The response structure of the API has changed	View Change Details