DescribeTables - Amazon DynamoDB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

DescribeTables

重要

本节介绍已经弃用的 API 版本 2011-12-05,不应用于新应用程序。

有关当前低级别 API 的文档,请参阅 Amazon DynamoDB API 参考

描述

返回表的信息,包括表的当前状态、主键架构以及表的创建时间。DescribeTable 的结果具有最终一致性。如果在创建表的过程中过早使用 DescribeTable,DynamoDB 将返回 ResourceNotFoundException。如果在创建表的过程中过早使用 DescribeTable,新值可能不会立即可用。

请求

Syntax(语法)

// This header is abbreviated. // For a sample of a complete header, see DynamoDB 低级 API. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.DescribeTable content-type: application/x-amz-json-1.0 {"TableName":"Table1"}
名称 描述 必填
TableName

要描述的表的名称。

类型:字符串

进程正在等待确保选择用于 Autovacuum 的表仍然需要进行 vacuum 操作。

响应

Syntax(语法)

HTTP/1.1 200 x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375 content-type: application/x-amz-json-1.0 Content-Length: 543 {"Table": {"CreationDateTime":1.309988345372E9, ItemCount:1, "KeySchema": {"HashKeyElement":{"AttributeName":"AttributeName1","AttributeType":"S"}, "RangeKeyElement":{"AttributeName":"AttributeName2","AttributeType":"N"}}, "ProvisionedThroughput":{"LastIncreaseDateTime": Date, "LastDecreaseDateTime": Date, "ReadCapacityUnits":10,"WriteCapacityUnits":10}, "TableName":"Table1", "TableSizeBytes":1, "TableStatus":"ACTIVE" } }
名称 描述
Table

正在描述的表的容器。

类型:字符串

CreationDateTime UNIX 纪元时间表示的表创建日期。
ItemCount

指定表中的项目数。DynamoDB 大约每 6 小时更新一次此值。此值可能不反映最近更改。

类型:数字

KeySchema 表的主键(简单或复合)结构。HashKeyElement 的名称-值对是必填的,RangeKeyElement 的名称-值对是可选的(只有复合主键需要)。Hash 键最大为 2048 字节。Range 键最大为 1024 字节。这两个限制单独执行(即,可以组合 hash + range 2048 + 1024 键)。有关主键的更多信息,请参阅 主键
ProvisionedThroughput 指定表的吞吐量,由 LastIncreaseDateTime(如果适用)、LastDecreaseDateTime(如果适用)、ReadCapacityUnitsWriteCapacityUnits 值组成。如果表的吞吐量从未增加或减少,DynamoDB 不会返回这些元素的值。请参阅 管理 DynamoDB 预置容量表的吞吐量设置

类型:数组

TableName

请求表的名称。

类型:字符串

TableSizeBytes

指定表的总大小(以字节为单位)。DynamoDB 大约每 6 小时更新一次此值。此值可能不反映最近更改。

类型:数字

TableStatus 表的当前状态(CREATINGACTIVEDELETINGUPDATING)。表处于 ACTIVE 状态后,可以添加数据。

特殊错误

没有特定于此操作的错误。

示例

以下示例显示对 "comp-table" 表的 HTTP POST 请求,以及使用 DescribeTable 操作的响应。此表具有复合主键。

示例请求

// This header is abbreviated. // For a sample of a complete header, see DynamoDB 低级 API. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.DescribeTable content-type: application/x-amz-json-1.0 {"TableName":"users"}

示例响应

HTTP/1.1 200 x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375 content-type: application/x-amz-json-1.0 content-length: 543 {"Table": {"CreationDateTime":1.309988345372E9, "ItemCount":23, "KeySchema": {"HashKeyElement":{"AttributeName":"user","AttributeType":"S"}, "RangeKeyElement":{"AttributeName":"time","AttributeType":"N"}}, "ProvisionedThroughput":{"LastIncreaseDateTime": 1.309988345384E9, "ReadCapacityUnits":10,"WriteCapacityUnits":10}, "TableName":"users", "TableSizeBytes":949, "TableStatus":"ACTIVE" } }