Queries 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
Action String Yes GetTable

The operation that you want to perform. Set the value to GetTable.

DbName String Yes db001

The name of the database.

TableName String Yes tbl001

The name of the table that you want to query.

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 was successful.

Table Object

The information of the table.

CreateTime Long 20190813

The time when the table was created.

DbName String db001

The name of the database.

LastAccessTime Long 20190814

The time when the table was last accessed.

Owner String user001

The owner of the table.

Parameters Map

The properties of the table.

String key001=value001

The properties of the table.

PartitionKeys Array of PartitionKeys

The partition in the table.

Comment String this is partition comment

The comment of the partition.

Name String part001

The name of the partition key column.

Type String int

The data type of the partition key column.

StorageDescriptor Object

The SerDe of the table.

Cols Array of Cols

The columns in the table.

Comment String this is column comment

The comment of the column.

Name String col1

The name of the column.

Type String string

The data 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 OSS directory in which the table is saved.

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

The output format of the table.

Parameters Map

The SerDe properties.

SerDeInfo Object

The SerDe information.

Name String SerDeName

The SerDe name.

Parameters Map

The SerDe properties.

String key001=value001

The SerDe properties.

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

The class library that is used to process SerDe.

TableName String tbl001

The name of the table that you queried.

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 that is used to query the view.

ViewOriginalText String select count(*) from tbl002

The original SQL statement that is used to query the view.

Examples

Sample requests

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

Sample responses

JSON format

HTTP/1.1 200 OK

Error codes

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