Check Batch Table Access Permissions with CheckBatchTableAccessPermission API - Data Management - Alibaba Cloud - Data Management

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

dms:CheckBatchTableAccessPermission

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TableNameList	array	Yes	The names of the tables to check.
	string	Yes	The name of the table.	test_name
DbId	integer	Yes	The database ID. You can call the ListDatabases operation to query the ID of a physical database and the ListLogicDatabases operation to query the ID of a logical database. Note The value of DatabaseId is that of DbId.	43XXX
Logic	boolean	No	Whether the database is a logical database. Valid values: true: Logical database. false: Physical database.	false
PermissionType	string	Yes	The permission type to verify. Valid values: QUERY EXPORT CORRECT LOGIN PERF	QUERY
Tid	integer	No	The ID of the tenant. Note To find the tenant ID, hover over your profile icon in the DMS console. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	3***

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	B43AD641-49C2-5299-9E06-1B37EC1B****
Data	array<object>	The dataset.
	object	The data returned.
TableName	string	The name of the table.	tab_add_teacher_record
Success	string	true: Permission granted false: Permission denied	True
ErrorMessage	string	The error message returned if the request failed.	NoPermission
ErrorCode	string	The error code.	UnknownError
Success	boolean	Whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "B43AD641-49C2-5299-9E06-1B37EC1B****",
  "Data": [
    {
      "TableName": "tab_add_teacher_record",
      "Success": "True",
      "ErrorMessage": "NoPermission"
    }
  ],
  "ErrorCode": "UnknownError",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.