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

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

GetItem

重要

This section refers to API version 2011-12-05, which is deprecated and should not be used for new applications.

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

Description

操作为与主键匹配的项目返回一组 GetItemAttributes如果没有匹配的项目,GetItem 不会返回任何数据。

默认情况下,GetItem 操作提供最终一致性读取。如果您的应用程序不接受最终一致性读取,请使用 ConsistentRead。 虽然此操作可能需要比标准读取更长的时间,但它始终会返回上次更新的值。有关更多信息,请参阅读取一致性

Requests

Syntax

// This header is abbreviated. // For a sample of a complete header, see DynamoDB 低级 API. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.GetItem content-type: application/x-amz-json-1.0 {"TableName":"Table1", "Key": {"HashKeyElement": {"S":"AttributeValue1"}, "RangeKeyElement": {"N":"AttributeValue2"} }, "AttributesToGet":["AttributeName3","AttributeName4"], "ConsistentRead":Boolean }
名称 描述 必需
TableName

包含所请求项目的表的名称。

类型: 字符串

Key

定义项目的主键值。有关主键的更多信息,请参阅主键

类型: 将 HashKeyElement 映射到其值,并将 RangeKeyElement 映射到其值。

AttributesToGet

属性名称数组。如果未指定属性名称,则将返回所有属性。如果未找到某些属性,则它们不会显示在结果中。

类型: 数组

ConsistentRead

如果设置为 true,则将发出一致性读取,否则将使用最终一致性。

类型: Boolean

Responses

Syntax

HTTP/1.1 200 x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375 content-type: application/x-amz-json-1.0 content-length: 144 {"Item":{ "AttributeName3":{"S":"AttributeValue3"}, "AttributeName4":{"N":"AttributeValue4"}, "AttributeName5":{"B":"dmFsdWU="} }, "ConsumedCapacityUnits": 0.5 }
名称 描述
Item

包含请求的属性。

类型: 属性名称/值对的映射。

ConsumedCapacityUnits

操作占用的读取容量单位数。此值显示应用于预置吞吐量的数量。对不存在的项目的请求会占用最小读取容量单位,具体取决于读取类型。有关更多信息,请参阅 管理 DynamoDB 预置容量表的设置

类型: 数字

特殊错误

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

Examples

有关使用 AWS 开发工具包的示例,请参阅使用项目和属性

示例请求

// This header is abbreviated. // For a sample of a complete header, see DynamoDB 低级 API. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.GetItem content-type: application/x-amz-json-1.0 {"TableName":"comptable", "Key": {"HashKeyElement":{"S":"Julie"}, "RangeKeyElement":{"N":"1307654345"}}, "AttributesToGet":["status","friends"], "ConsistentRead":true }

示例响应

请注意 ConsumedCapacityUnits 值为 1,因为可选参数 ConsistentRead 设置为 true。 如果同一请求的 ConsistentRead 设置为 false(或未指定),则响应最终是一致的,并且 ConsumedCapacityUnits 值将是 0.5。

HTTP/1.1 200 x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375 content-type: application/x-amz-json-1.0 content-length: 72 {"Item": {"friends":{"SS":["Lynda, Aaron"]}, "status":{"S":"online"} }, "ConsumedCapacityUnits": 1 }