DescribeAccounts - AnalyticDB - Alibaba Cloud Documentation Center

Queries the database accounts of a cluster.

Operation description

For the endpoint of this service, see Endpoints.

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

list

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the Data Lakehouse Edition cluster.	amv-bp11q28kvl688****
AccountName	string	No	The database account. Note If you do not specify this parameter, information about all database accounts is returned.	test_accout
Engine	string	No	The database engine. Valid values: AnalyticDB (default): the AnalyticDB for MySQL engine Clickhouse: the LindormTable engine	Clickhouse

Response elements

Element	Type	Description	Example
	object	The list of database accounts.
RequestId	string	The request ID.	9CCFAAB4-97B7-5800-B9F2-685EB596E3EF
AccountList	object
DBAccount	array<object>	The list of database accounts.
	array<object>	The details of the account.
AccountName	string	The database account.	test_accout
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.	测试数据库账号
RamUsers	string	The ID of the RAM user.	1958134230****
AccountType	string	The type of the account. Valid values: Normal: standard account. Super: privileged account.	Normal
Engine	string	The database engine. Valid values: AnalyticDB: The AnalyticDB for MySQL engine. ClickHouse: The wide-table engine.	Clickhouse
RamUserList	object
RamUserList	array	A list of IDs of the attached Alibaba Cloud RAM users.
	string	The ID of an attached Alibaba Cloud RAM user.	20732900249392****

Examples

Success response

JSON format

{
  "RequestId": "9CCFAAB4-97B7-5800-B9F2-685EB596E3EF",
  "AccountList": {
    "DBAccount": [
      {
        "AccountName": "test_accout",
        "AccountStatus": "Available",
        "AccountDescription": "测试数据库账号",
        "RamUsers": "1958134230****",
        "AccountType": "Normal",
        "Engine": "Clickhouse",
        "RamUserList": {
          "RamUserList": [
            "20732900249392****"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBClusterId.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.
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The DBClusterId parameter is invalid. Check the parameter.
400	ACS.Sql.CannotConnect	Cannot connect instance which type is %s.	Cannot connect to a child instance of the given type.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.