メニュー
Amazon DynamoDB
開発者ガイド (API Version 2012-08-10)

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 は、この値を約 6 時間ごとに更新します。そのため、最近の変更が値に反映されていない可能性があります。

型: 数値

KeySchema テーブルのプライマリキー(単純または複合)構造。HashKeyElement の名前と値のペアは必須です。RangeKeyElement の名前と値のペアはオプションです(複合プライマリキーの場合のみ、必須)。ハッシュキーの最大サイズは 2048 バイトです。範囲キーの最大サイズは 1024 バイトです。両方の制限は個別に適用されます(つまり、結合したハッシュ + 範囲 2048 + 1024 キーを使用できます)。プライマリキーの詳細については、「プライマリキー」を参照してください。
ProvisionedThroughput 指定したテーブルのスループット。LastIncreaseDateTime(該当する場合)、LastDecreaseDateTime(該当する場合)、ReadCapacityUnits、および WriteCapacityUnits の値で構成されます。テーブルのスループットが増加または減少したことがない場合、DynamoDB はこれらの要素の値を返しません。「読み取りと書き込みのスループット設定」を参照してください。

型: 配列

TableName

リクエストしたテーブルの名前。

型: 文字列

TableSizeBytes

指定したテーブルの合計サイズ(バイト単位)。DynamoDB は、この値を約 6 時間ごとに更新します。そのため、最近の変更が値に反映されていない可能性があります。

型: 数値

TableStatus テーブルの現在の状態(CREATINGACTIVEDELETING、または UPDATING)。テーブルが 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" } }