Use DescribeAccounts to query database account details - AnalyticDB - Alibaba Cloud - AnalyticDB

Describes the database accounts of an AnalyticDB for MySQL cluster.

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

adb:DescribeAccounts

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters in a specific region.	amv-bp11q28kvl688****
AccountName	string	No	The name of the database account. Note If you omit this parameter, information about all database accounts is returned.	test_accout
Tags	array<object>	No	The resource tags.
	object	No	A resource tag.
Key	string	No	The key of the tag. Note You can call the TagResources operation to create a tag for a cluster.	AnalyticDB_IO_UTIL
Value	string	No	The value of the tag.	low_env
AccountType	string	No	The account type. By default, accounts of all types are returned. Valid values: Normal: a standard account. Super: a privileged account.	Super

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	9CCFAAB4-97B7-5800-B9F2-685EB596E3EF
AccountList	object	The information about the database accounts.
DBAccount	array<object>	The database accounts.
	array<object>	The details of the database account.
AccountStatus	string	The state of the account. Valid values: Creating: The account is being created. Available: The account is available. Deleting: The account is being deleted.	Available
AccountDescription	string	The description of the account.	C@test
Tags	object	The tags.
Tag	array<object>	A list of tags.
	object	The details of the tag.
Key	string	The key of the tag. Note You can call the TagResources operation to create a tag for a cluster.	AnalyticDB_CPU
Value	string	The value of the tag.	0
AccountType	string	The type of the account. Valid values: Normal: a standard account. Super: a privileged account.	Super
AccountName	string	The name of the database account.	adb_user1

Examples

Success response

JSON format

{
  "RequestId": "9CCFAAB4-97B7-5800-B9F2-685EB596E3EF",
  "AccountList": {
    "DBAccount": [
      {
        "AccountStatus": "Available",
        "AccountDescription": "C@test",
        "Tags": {
          "Tag": [
            {
              "Key": "AnalyticDB_CPU",
              "Value": "0"
            }
          ]
        },
        "AccountType": "Super",
        "AccountName": "adb_user1"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.