All Products
Search
Document Center

AnalyticDB:DescribeAccountPrivilegeObjects

Last Updated:Nov 10, 2025

Queries the databases, tables, and columns on which a database account has permissions.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:DescribeAccountPrivilegeObjectslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the cluster.

ch-hangzhou
DBClusterIdstringYes

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

amv-bp1k3wdmt139****
AccountNamestringYes

The name of the database account.

test
PrivilegeTypestringNo

The permission level. Valid values: Database, Table, and Column. Global is not supported.

Column
DatabasePrivilegeObjectstringNo

The database name that is used to filter databases.

database1
TablePrivilegeObjectstringNo

The table name that is used to filter tables.

table1
PageNumberstringNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizestringNo

The number of entries per page. Default value: 20.

20
ColumnPrivilegeObjectstringNo

The column name that is used to filter columns.

col1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

34B2AD29-682F-1C14-B3AA-9EF1A96084B8
Dataarray<object>

The permissions.

dataobject

The permission objects, including the database, table, and column.

Databasestring

The name of the database. This parameter is returned when PrivilegeType is set to Database, Table, or Column.

tdb1
Tablestring

The name of the table. This parameter is returned when PrivilegeType is set to Table or Column.

table1
Columnstring

The name of the column. This parameter is returned when PrivilegeType is set to Column.

column1
Descriptionstring

The description that is specified when you create a table or column. This parameter is returned only when PrivilegeType is set to Database or Table, indicating the database description or table description.

a test db
TotalCountlong

The total number of entries returned.

23
PageNumberlong

The page number.

1
PageSizelong

The number of entries per page.

20

Examples

Sample success responses

JSONformat

{
  "RequestId": "34B2AD29-682F-1C14-B3AA-9EF1A96084B8",
  "Data": [
    {
      "Database": "tdb1",
      "Table": "table1",
      "Column": "column1",
      "Description": "a test db"
    }
  ],
  "TotalCount": 23,
  "PageNumber": 1,
  "PageSize": 20
}

Error codes

HTTP status codeError codeError messageDescription
400ACS.Account.NotExistThe account is not found.The specified RAM user does not exist.
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The DBClusterId parameter is invalid. Check the parameter.
400ACS.InvalidParameter.%sParameter %s is invalid.The specified parameter is invalid.
400InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.
400ACS.User.NotBindDatabaseAccountThe user has not been associated with a database account.The user is not associated with the database account.

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

Change history

Change timeSummary of changesOperation
2023-12-06The Error code has changedView Change Details
2023-04-20The Error code has changedView Change Details
2023-03-24The internal configuration of the API is changed, but the call is not affectedView Change Details