DescribeTable - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about a table.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeTable	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-xxxxxxxxx
RegionId	string	Yes	The region ID of the instance.	cn-beijing
SecretArn	string	Yes	The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential. Note To call the DescribeTable operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.	acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ
Database	string	Yes	The name of the database.	adbtest
Schema	string	Yes	The name of the schema to which the table belongs.	public
Table	string	Yes	The name of the table.	mytable

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	The returned message.	success
Status	string	The status of the operation. Valid values: success fail	success
ColumnList	array	The columns of the table.
ColumnList	ColumnMetadata	The column of the table.

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "ColumnList": {
    "ColumnList": [
      {
        "Name": "",
        "DataType": "",
        "ColumnDefault": "",
        "MaxLength": 0,
        "Nullable": true,
        "SchemaName": "",
        "TableName": "",
        "IsCaseSensitive": true,
        "IsCurrency": true,
        "IsSigned": true,
        "Precision": 0,
        "Scale": 0,
        "IsPrimaryKey": true,
        "Comment": "",
        "UdtName": ""
      }
    ]
  }
}

Error codes

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