DescribeAccounts - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B562A65B-39AB-4EE8-8635-5A222054FB35
Accounts	object
Account	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.	管理员
DBInstanceId	string	The ID of the instance to which the account belongs.	dds-bp1fd530f271****
AccountName	string	The name of the account.	root

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.