All Products
Search
Document Center

AnalyticDB:DescribeAccounts

Last Updated:Oct 12, 2024

Queries the database accounts of an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeAccountslist
  • DBClusterLakeVersion
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.

amv-bp11q28kvl688****
AccountNamestringNo

The name of the database account.

Note If you do not specify this parameter, the information about all database accounts in the cluster is returned.
test_accout
EnginestringNo

The database engine of the cluster. Valid values:

  • AnalyticDB (default): the AnalyticDB for MySQL engine.
  • Clickhouse: the wide table engine.
Clickhouse

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

9CCFAAB4-97B7-5800-B9F2-685EB596E3EF
AccountListarray<object>

The queried database accounts.

DBAccountobject

The queried database account.

AccountNamestring

The name of the database account.

test_accout
AccountStatusstring

The status of the database account. Valid values:

  • Creating
  • Available
  • Deleting
Available
AccountDescriptionstring

The description of the database account.

test_accout_des
RamUsersstring

The ID of the Resource Access Management (RAM) user.

1958134230****
AccountTypestring

The type of the database account. Valid values:

  • Normal: standard account.
  • Super: privileged account.
Normal
Enginestring

The database engine of the cluster. Valid values:

  • AnalyticDB: the AnalyticDB for MySQL engine.
  • Clickhouse: the wide table engine.
Clickhouse

Examples

Sample success responses

JSONformat

{
  "RequestId": "9CCFAAB4-97B7-5800-B9F2-685EB596E3EF",
  "AccountList": {
    "DBAccount": [
      {
        "AccountName": "test_accout",
        "AccountStatus": "Available",
        "AccountDescription": "test_accout_des",
        "RamUsers": "1958134230****",
        "AccountType": "Normal",
        "Engine": "Clickhouse"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The DBClusterId parameter is invalid. Check the parameter.
400ACS.Sql.CannotConnectCannot connect instance which type is %s.Cannot connect to a child instance of the given type.

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

Change history

Change timeSummary of changesOperation
2024-08-09The Error code has changedView Change Details
2024-06-13The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-03-31The Error code has changedView Change Details