DescribeAccounts - AnalyticDB - Alibaba Cloud Documentation Center

Queries the details of accounts in a 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 Data Warehouse Edition (V3.0) cluster. Note Call the DescribeDBClusters operation to query the IDs of all Data Warehouse Edition (V3.0) clusters in the destination region.	amv-bp11q28kvl688****
AccountName	string	No	The database account. Note If this parameter is not specified, information about all database accounts is returned.	test_accout
Tags	array<object>	No	The resource tags.
	object	No	The resource tags.
Key	string	No	The tag key. Note Call the TagResources operation to create tags for the cluster.	AnalyticDB_IO_UTIL
Value	string	No	The tag value.	low_env
AccountType	string	No	The account type. If you leave this parameter empty, information about accounts of all types is returned. Valid values: Normal: standard account. Super: privileged account.	Super

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9CCFAAB4-97B7-5800-B9F2-685EB596E3EF
AccountList	object
DBAccount	array<object>	The list of accounts.
	array<object>
AccountStatus	string	The status of the account. Valid values: Creating: The account is being created. Available: The account is active. Deleting: The account is being deleted.	Available
AccountDescription	string	The description of the account.	C@test
Tags	object
Tag	array<object>	The list of tags.
	object	The details of the list.
Key	string	The tag key. Note Call the TagResources operation to create tags for the cluster.	AnalyticDB_CPU
Value	string	The tag value.	0
AccountType	string	The account type. Valid values: Normal: standard account. Super: 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.