Amazon DynamoDB
开发人员指南 (API Version 2012-08-10)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。点 击 Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

DescribeTables

重要

本节引用 API 版本 2011-12-05,此版本已被弃用且不应该用于新应用程序。

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

说明

返回有关表的信息,包括表的当前状态、主键架构和表的创建时间。DescribeTable 结果是最终一致的。如果您在创建表的过程中过早使用 DescribeTable,则 DynamoDB 将返回 ResourceNotFoundException。如果您在更新表的过程中过早使用 DescribeTable,则新值可能无法立即可用。

请求

语法

Copy
// 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

要描述的表的名称。

类型:字符串

响应

语法

Copy
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 大约每六小时更新一次此值。此值可能不会反映最近的更改。

类型:数字

KeySchema 表的主键(简单或者复合)结构。HashKeyElement 的名称/值对是内容,而 RangeKeyElement 的名称/值对为可选内容(只有复合主键才需要该内容)。最大哈希键大小为 2048 字节。最大范围键大小为 1024 字节。两个限制是分别实施的(即,您可以有一个哈希 + 范围 2048 + 1024 组合键)。有关主键的更多信息,请参阅 主键
ProvisionedThroughput 指定的表的吞吐量,由 LastIncreaseDateTime(如果适用)、LastDecreaseDateTime(如果适用)、ReadCapacityUnitsWriteCapacityUnits 的值组成。如果从未增加或减少该表的吞吐量,则 DynamoDB 不返回这些元素的值。请参阅读取和写入的吞吐量设置

类型:数组

TableName

所请求的表的名称。

类型:字符串

TableSizeBytes

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

类型:数字

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

特殊错误

没有错误特定于此操作。

示例

以下示例显示了对名为“comp-table”的表使用 DescribeTable 操作的 HTTP POST 请求和响应。该表具有复合主键。

示例请求

Copy
// 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"}

示例响应

Copy
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" } }