Query the details of one or more tables.
Debugging
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 Resourcesis 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:getTableObjects | get | *DBClusterLakeVersion acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SchemaName | string | Yes | The name of the database. | adb_demo |
| OrderBy | string | No | The order in which the fields to be returned are sorted. Valid values:
Values for fields: TableName TableSize CreateTime UpdateTime Default value: {"Type": "Desc","Field": "TableName"}; | {"Type": "Desc","Field": "TableName"} |
| FilterTblName | string | No | The name of the table. | test_tbl |
| PageNumber | long | Yes | The number of the page to return. The value is an integer that is greater than 0. Default value: 1. | 1 |
| PageSize | long | Yes | The number of entries to return on each page. Valid values:
Default value: 30. | 30 |
| DBClusterId | string | Yes | The ID of the cluster. | am-bp1565u55p32**** |
| FilterTblType | string | No | The type of the table. Valid values: DIMENSION_TABLE FACT_TABLE EXTERNAL_TABLE Default value: null. | FACT_TABLE |
| FilterOwner | string | No | The owner of the table. | admin |
| FilterDescription | string | No | The description of the table. | description |
| RegionId | string | Yes | The ID of the region in which the cluster resides. | cn-hangzhou |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "863D51B7-5321-41D8-A0B6-A088B0******",
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 1,
"Data": {
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 1,
"TableSummaryModels": [
{
"SchemaName": "schemaName",
"TableName": "tableName",
"TableType": "PHYSICAL_SCHEMA_NAME",
"TableSize": 1234,
"CreateTime": "2023-01-05 13:17:55",
"UpdateTime": "2023-01-05 13:17:55",
"SQL": "create table(a varchar)",
"Description": "descrtiption",
"Owner": "abc"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | MDS.IllegalArgument | Invalid argument. | An invalid parameter is used. |
| 400 | MDS.InvalidPrivilege | No permissions. | You are not authorized to perform this operation. |
| 400 | MDS.MetaSchemaAlreadyExist | The database already exists. | The specified database already exists. |
| 400 | MDS.MetaSchemaNotExist | The database does not exist. | The specified database does not exist. |
| 400 | MDS.MetaTableAlreadyExist | The table already exists. | The specified table already exists. |
| 400 | MDS.MetaTableNotExist | The table is not found. | The specified table does not exist. |
| 500 | MDS.InternalError | An internal MDS error occurred. | An internal error occurred. |
| 500 | MDS.MetaVisitError | Failed to access metadata. | Failed to access the metadata. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-08-20 | The Error code has changed | View Change Details |
| 2023-10-25 | The Error code has changed | View Change Details |
| 2023-03-22 | The Error code has changed | View Change Details |
