DescribeAdbMySqlTableMeta - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about table metadata.

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
adb:DescribeAdbMySqlTableMeta	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.	am-bp11q28kvl688****
Schema	string	Yes	The name of the database.	adb_demo
TableName	string	Yes	The name of the table. Note If you leave this parameter empty, the information about all the current tables in the cluster is returned.	test

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The returned message. Valid values: If the request was successful, a success message is returned.**** If the request failed, an error message is returned.	Success
RequestId	string	The request ID.	2FED790E-FB61-4721-8C1C-07C627FA5A19
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
TableMeta	object	The queried table metadata.
TableSchema	string	The database to which the table belongs.	tpch
TableName	string	The name of the table. **	external_supplier
TableType	string	The type of the table.	fact_table
DistributeType	string	The distribution type.	hash
DistributeColumn	string	The distribution key column.	customer_id
PartitionType	string	The type of the partition.	value
PartitionColumn	string	The partition key column.	DATE_FORMAT(login_time, '%Y%m%d')
PrimaryKeyColumn	string	The primary key column.	login_time,customer_id,phone_num
TableEngine	string	The table engine.	XUANWU
IsDictEncode	boolean	Indicates whether dictionary encoding is used.	true
IsHidden	boolean	Indicates whether pages are hidden. false true	true
IsAllIndex	boolean	Indicates whether full-column indexes are used.	false
IsFullTextDict	boolean	Indicates whether full-text indexes are used.	true
CreateTime	string	The time when the table was created.	2025-03-14 02:18:08.0
UpdateTime	string	The time when the table was updated.	2024-07-25 02:07:23.0

Examples

Sample success responses

JSONformat

{
  "Message": "Success",
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627FA5A19",
  "Success": true,
  "TableMeta": {
    "TableSchema": "tpch",
    "TableName": "external_supplier",
    "TableType": "fact_table",
    "DistributeType": "hash",
    "DistributeColumn": "customer_id",
    "PartitionType": "value",
    "PartitionColumn": "DATE_FORMAT(login_time, '%Y%m%d')",
    "PrimaryKeyColumn": "login_time,customer_id,phone_num",
    "TableEngine": "XUANWU",
    "IsDictEncode": true,
    "IsHidden": true,
    "IsAllIndex": false,
    "IsFullTextDict": true,
    "CreateTime": "2025-03-14 02:18:08.0",
    "UpdateTime": "2024-07-25 02:07:23.0"
  }
}

Error codes

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