DescribeAccountPrivilegeObjects-阿里云帮助中心

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.

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:DescribeAccountPrivilegeObjects

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the cluster.	ch-hangzhou
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.	amv-bp1k3wdmt139****
AccountName	string	Yes	The name of the database account.	test
PrivilegeType	string	No	The permission level. Valid values: Database, Table, and Column. Global is not supported.	Column
DatabasePrivilegeObject	string	No	The database name that is used to filter databases.	database1
TablePrivilegeObject	string	No	The table name that is used to filter tables.	table1
PageNumber	string	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	string	No	The number of entries per page. Default value: 20.	20
ColumnPrivilegeObject	string	No	The column name that is used to filter columns.	col1

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	34B2AD29-682F-1C14-B3AA-9EF1A96084B8
Data	array<object>	The permissions.
	object	The permission objects, including the database, table, and column.
Database	string	The name of the database. This parameter is returned when PrivilegeType is set to Database, Table, or Column.	tdb1
Table	string	The name of the table. This parameter is returned when PrivilegeType is set to Table or Column.	table1
Column	string	The name of the column. This parameter is returned when PrivilegeType is set to Column.	column1
Description	string	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
TotalCount	integer	The total number of entries returned.	23
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	20

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	ACS.Account.NotExist	The account is not found.	The specified RAM user does not exist.
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The DBClusterId parameter is invalid. Check the parameter.
400	ACS.InvalidParameter.%s	Parameter %s is invalid.	The specified parameter is invalid.
400	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
400	ACS.User.NotBindDatabaseAccount	The user has not been associated with a database account.	The user is not associated with the database account.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.