DescribeTables - PolarDB - Alibaba Cloud Documentation Center

Calls the DescribeTables operation to retrieve a list of table information.

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

drds:DescribeTables

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drds************
DbName	string	Yes	The database name.	test
Query	string	No	The query condition. Set this parameter to the instance ID of the target instance.	drds************
PageSize	integer	No	The number of entries per page.	10
CurrentPage	integer	No	The current page number.	1
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
RequestId	string	The request ID.	83AC3D7E-461C-4D87-8ACD-6CC295******
Total	integer	The total number of entries.	1
Success	boolean	Indicates whether the request was successful.	true
List	array<object>	The list of table information returned.
	object
Status	integer	The status of the split task. Valid values: 0: Normal. No task is running. 1: Changing. A split task is running.	0
IsLocked	boolean	Indicates whether the table is locked.	false
ShardKey	string	The shard key.	null
IsShard	boolean	Indicates whether the table is sharded.	false
Broadcast	boolean	Indicates whether the table is a broadcast table.	false
AllowFullTableScan	boolean	Indicates whether full table scan is allowed.	false
Table	string	The table name.	test
DbInstType	integer	The instance type. Valid values: 0: dedicated 1: shared.	0

Examples

Success response

JSON format

{
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "83AC3D7E-461C-4D87-8ACD-6CC295******",
  "Total": 1,
  "Success": true,
  "List": [
    {
      "Status": 0,
      "IsLocked": false,
      "ShardKey": "null",
      "IsShard": false,
      "Broadcast": false,
      "AllowFullTableScan": false,
      "Table": "test",
      "DbInstType": 0
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.