edit-icon download-icon

DescribeTable

Last Updated: Mar 23, 2018

Action:

DescribeTable queries the structure information and the reserved read/write throughput value of the specified table.

Request structure:

  1. message DescribeTableRequest {
  2. required string table_name = 1;
  3. }

table_name:

  • Type: String

  • Required parameter: Yes

  • The name of the table to be queried.

Response message structure:

  1. message DescribeTableResponse {
  2. required TableMeta table_meta = 1;
  3. required ReservedThroughputDetails reserved_throughput_details = 2;
  4. required TableOptions table_options = 3;
  5. optional StreamDetails stream_details = 5;
  6. repeated bytes shard_splits = 6;
  7. }

table_meta:

  • Type: TableMeta

  • The table’s schema, which is the same as the Schema given at the time of table creation.

reserved_throughput_details:

  • Type: ReservedThroughputDetails

  • The table’s reserved read/write throughput settings information. In addition to the current reserved read/write throughput settings, it also contains the time these settings were last updated and the number of times they have been lowered for the current date.

table_options:

  • Type: TableOptions

  • The latest value of the table_options parameter.

StreamSpecification:

  • Type: StreamSpecification

  • Required parameter: No

  • Specifies whether to enable Stream-related attributes.

shard_splits:

  • Type: bytes

  • The split points of all shards in the current table.

Thank you! We've received your feedback.