DescribeTable - PolarDB - Alibaba Cloud Documentation Center

Queries table schema information by calling the DescribeTable operation.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
DrdsInstanceId	string	Yes	The instance ID.	drds*********
DbName	string	Yes	The database name.	drds_flashback
TableName	string	Yes	The table name.	employee_split

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the API request was successful.	true
RequestId	string	The unique request ID. If an issue occurs, provide this ID to support engineers for troubleshooting.	B5644ABB-559A-4A1C-83F2-9E7209******
Data	object	The returned data.
List	array<object>	The collection of returned data.
	object
Index	string	Indicates the primary key of the table.	PRI
IsAllowNull	string	Indicates whether the column can be empty.	NO
ColumnName	string	Indicates the name of a column.	Id
IsPk	string	Indicates whether the column is the primary key column of the table.	YES
ColumnType	string	Indicates the type of the column.	bigint(20)
Extra	string	Extra	auto_increment

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "B5644ABB-559A-4A1C-83F2-9E7209******",
  "Data": {
    "List": [
      {
        "Index": "PRI",
        "IsAllowNull": "NO",
        "ColumnName": "Id",
        "IsPk": "YES",
        "ColumnType": "bigint(20)",
        "Extra": "auto_increment"
      }
    ]
  }
}

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.