Queries the details of a specific table.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
DbName String Yes db001

The name of the database.

TableName String Yes tbl001

The name of the table.

Response parameters

Parameter Type Example Description
Code String NO_SUCH_OBJECT

The error code returned.

Message String No such table: db001.tbl001

The error message returned.

RequestId String 9BEAC206-0795-4DE3-B1FD-964BEF432B23

The ID of the request.

Success Boolean false

Indicates whether the request is successful.

Table object

The information of the table.

CreateTime Long 12234

The time when the table was created.

DbName String db001

The name of the database.

LastAccessTime Long 1234

The time when the table was last accessed.

Owner String user001

The username of the sub-account used to create the table.

Parameters Map

The attributes of the table.

String key001=value001

The values of table attributes.

PartitionKeys Array of PartitionKeys

The partitions in the table.

Comment String this is partition comment

The remarks on the partitions in the table.

Name String part001

The name of the partition field.

Type String int

The type of the partition key column.

StorageDescriptor object

The information of the storage space of the table.

Cols Array of Cols

The columns in the table.

Comment String this is column comment

The remarks on the columns in the table.

Name String col1

The name of the column.

Type String string

The type of the column.

InputFormat String org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat

The input format of the table.

Location String oss://data/xxxx

The URL of the Object Storage Service (OSS) bucket in which the table is stored.

OutputFormat String org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat

The output format of the table.

Parameters Map

The attributes of the storage space of the table.

SerDeInfo object

The information of the serializer/deserializer (SerDe).

Name String SerDeName

The name of the SerDe.

Parameters Map

The attributes of the SerDe.

String key001=value001

The values of SerDe attributes.

SerializationLib String org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe

The class library used by the SerDe to perform serialization and deserialization.

TableName String tbl001

The name of the table.

TableType String VIEW

The type of the table. Valid values: VIEW, MANAGED_TABLE, EXTERNAL_TABLE, and VIRTUAL_VIEW.

ViewExpandedText String select count(*) from tbl002

The extended SQL statement used to query the view.

ViewOriginalText String select count(*) from tbl002

The original SQL statement used to query the view.

Examples

Sample requests

http(s)://[Endpoint]/?TableName=tbl001
&DbName=db001
&<Common request parameters>

Error codes

For a list of error codes, visit the API Error Center.