Queries the schema and the reserved read or write throughput settings of a table.
Request syntax
message DescribeTableRequest {
required string table_name = 1;
}Parameter | Type | Required | Description |
table_name | string | Yes | The name of the table whose information you want to query. |
Response syntax
message DescribeTableResponse {
required TableMeta table_meta = 1;
required ReservedThroughputDetails reserved_throughput_details = 2;
required TableOptions table_options = 3;
optional StreamDetails stream_details = 5;
repeated bytes shard_splits = 6;
optional SSEDetails sse_details = 7;
repeated IndexMeta index_metas = 8;
optional int64 creation_time = 9;
}Parameter | Type | Description |
table_meta | The schema of the table. The schema is the same as the schema that was defined when the table was created. | |
reserved_throughput_details | The reserved read or write throughput settings of the table. The reserved read or write throughput settings of the table include the most recent reserved read or write throughput value, the time when the reserved read or write throughput value was last updated, and the number of times that the reserved read or write throughput value was decreased on the current day. | |
table_options | The most recent value of the table_options parameter. | |
stream_details | Indicates whether Stream-related attributes are enabled. | |
shard_splits | bytes | The split points of all partitions in the table. |
sse_details | SSEDetails | The information about server-side encryption. |
index_metas | IndexMeta | The schema information about the index table, including the index fields and index types. |
creation_time | int64 | The time when the data table was created. |
Use Tablestore SDKs
You can use the following Tablestore SDKs to query the schema and the reserved read or write throughput settings of a table:
Tablestore SDK for Java: Query the description of a table
Tablestore SDK for Go: Query the description of a table
Tablestore SDK for Python: Query the description of a table
Tablestore SDK for Node.js: Query the description of a table
Tablestore SDK for .NET: Query the description of a table
Tablestore SDK for PHP: Query the description of a table