ボールトのリスト (GET vaults) - Amazon S3 Glacier

英語の翻訳が提供されている場合で、内容が矛盾する場合には、英語版がオリジナルとして取り扱われます。翻訳は機械翻訳により提供されています。

ボールトのリスト (GET vaults)

説明

このオペレーションでは、呼び出し元のユーザーのアカウントによって所有されているすべてのボールトのリストを表示します。レスポンスとして返されるリストは、ボールト名で ASCII コード順にソートされます。

このオペレーションでは、デフォルトで最大でリクエストあたり 10 項目返されます。リストで表示した以上にボールトが存在する場合は、レスポンス本文の marker フィールドに、新しいボールトのリストリクエストでリストの続きを表示できるように、ボールトの Amazon リソースネーム (ARN) が含まれています。そうでない場合は、marker フィールドは null です。次回のボールトリストのリクエストでは、前回のボールトリストのリクエストに対するレスポンスとして Amazon S3 Glacier (S3 Glacier) によって返された値を marker パラメータに設定します。また、リクエストで limit パラメータを指定して、レスポンスで返されるボールトの数を制限することもできます。

リクエスト

ボールトのリストを取得するには、GET リクエストをボールトのリソースに送信します。

構文

GET /AccountId/vaults HTTP/1.1 Host: glacier.Region.amazonaws.com Date: Date Authorization: SignatureValue x-amz-glacier-version: 2012-06-01
注記

AccountId 値は、AWS アカウント ID です。この値は、リクエストの署名に使用した認証情報に関連付けられている AWS アカウント ID と一致している必要があります。AWS アカウント ID を指定するか、必要に応じて 1 つのハイフン (-) を指定できます。ハイフンを指定すると、Amazon S3 Glacier はリクエストの署名に使用した認証情報に関連付けられている AWS アカウント ID を使用します。お客様のアカウント ID を指定する場合は、ID にハイフンを含めないでください。

リクエストパラメータ

この操作では、次のリクエストパラメータを使用します。

名前 説明 必須
limit

返されるボールトの最大数。デフォルトの上限は 10 です。返されるボールトの数は、指定された上限を下回ることはあっても、上限を上回ることはありません。

型: 文字列

制約: 最小の整数値は 1 です。最大の整数値は 10 です。

いいえ
marker

ページ分割に使用する文字列。marker には、ボールトのリストの開始点となるボールトの ARN を指定します。(返されるリストには、marker に指定したボールトは含まれません)。 marker 値は、前回のボールトのリストのレスポンスから取得します。前回のボールドのリストのリクエストで開始された結果のページ分割を継続する場合のみ、marker を指定する必要があります。マーカーに空の値("")を指定すると、最初のボールトから始まるボールトのリストが返されます。

型: 文字列

制約: なし

いいえ

リクエストヘッダー

この操作では、すべての操作で共通のリクエストヘッダーのみ使用します。共通のリクエストヘッダーの詳細については、「一般的なリクエストヘッダー」を参照してください。

リクエストボディ

この操作にリクエストボディはありません。

レスポンス

構文

HTTP/1.1 200 OK x-amzn-RequestId: x-amzn-RequestId Date: Date Content-Type: application/json Content-Length: Length { "Marker": String "VaultList": [ { "CreationDate": String, "LastInventoryDate": String, "NumberOfArchives": Number, "SizeInBytes": Number, "VaultARN": String, "VaultName": String }, ... ] }

レスポンスヘッダー

この操作はほとんどのレスポンスに共通のレスポンスヘッダーのみを使用します。共通のレスポンスヘッダーの詳細については、「共通の応答ヘッダー」を参照してください。

レスポンス本文

レスポンスボディには次の JSON フィールドが含まれています。

CreationDate

ボールトが作成された、協定世界時(UTC)による日付。

タイプ: 文字列 たとえば 2013-03-20T17:03:43.221Z のような、ISO 8601 データフォーマットの文字列表記。

LastInventoryDate

ボールトのインベントリが最後に生成された、協定世界時(UTC)による日付。ボールトを作成したばかりのときなど、ボールトでインベントリが実行されていない場合、このフィールドの値は null です。ボールトのインベントリの開始の詳細については、「ジョブの開始 (ジョブの POST)」を参照してください。

タイプ: たとえば 2013-03-20T17:03:43.221Z のような、ISO 8601 データフォーマットの文字列表記。

Marker

結果のページ分割をどこから継続するかを示す vaultARN。リストに含まれるボールトをさらに取得するには、ボールトのリストの新規リクエストで marker を使用します。ボールトがそれ以上存在しない場合、この値は null です。

タイプ: 文字列

NumberOfArchives

最後にインベントリを生成した日付のボールトのアーカイブ数。

: 数値

SizeInBytes

最後にインベントリを生成した日付における、アーカイブごとのオーバーヘッドを含む、ボールトのすべてのアーカイブの合計サイズ (バイト単位)。

: 数値

VaultARN

ボールトの Amazon リソースネーム (ARN)。

タイプ: 文字列

VaultList

オブジェクトの配列。各オブジェクトにはボールトの説明が含まれます。

: 配列

VaultName

ボールト名。

タイプ: 文字列

エラー

Amazon S3 Glacier の例外とエラーメッセージの詳細については、「エラーレスポンス」を参照してください。

例: すべてのボールトのリスト

以下はボールトのリストを表示する例です。リクエストでは、marker および limit パラメータが指定されていないため、最大 10 個のボールトが返されます。

リクエストの例

GET /-/vaults HTTP/1.1 Host: glacier.us-west-2.amazonaws.com x-amz-Date: 20170210T120000Z x-amz-glacier-version: 2012-06-01 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2

レスポンスの例

Markernull であり、リストに表示するボールトがこれ以上存在しないことを示しています。

HTTP/1.1 200 OK x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q Date: Wed, 10 Feb 2017 12:02:00 GMT Content-Type: application/json Content-Length: 497 { "Marker": null, "VaultList": [ { "CreationDate": "2012-03-16T22:22:47.214Z", "LastInventoryDate": "2012-03-21T22:06:51.218Z", "NumberOfArchives": 2, "SizeInBytes": 12334, "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault1", "VaultName": "examplevault1" }, { "CreationDate": "2012-03-19T22:06:51.218Z", "LastInventoryDate": "2012-03-21T22:06:51.218Z", "NumberOfArchives": 0, "SizeInBytes": 0, "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault2", "VaultName": "examplevault2" }, { "CreationDate": "2012-03-19T22:06:51.218Z", "LastInventoryDate": "2012-03-25T12:14:31.121Z", "NumberOfArchives": 0, "SizeInBytes": 0, "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault3", "VaultName": "examplevault3" } ] }

例: ボールトの部分的なリスト

以下は、marker に指定したボールトから開始して 2 個のボールトを返す例です。

リクエストの例

GET /-/vaults?limit=2&marker=arn:aws:glacier:us-west-2:012345678901:vaults/examplevault1 HTTP/1.1 Host: glacier.us-west-2.amazonaws.com x-amz-Date: 20170210T120000Z x-amz-glacier-version: 2012-06-01 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2

レスポンスの例

2 個のボールトがリストに返されます。次回のボールトのリストのリクエストでページ分割を継続できるように、Marker にボールト ARN が含まれています。

HTTP/1.1 200 OK x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q Date: Wed, 10 Feb 2017 12:02:00 GMT Content-Type: application/json Content-Length: 497 { "Marker": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault3", "VaultList": [ { "CreationDate": "2012-03-16T22:22:47.214Z", "LastInventoryDate": "2012-03-21T22:06:51.218Z", "NumberOfArchives": 2, "SizeInBytes": 12334, "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault1", "VaultName": "examplevault1" }, { "CreationDate": "2012-03-19T22:06:51.218Z", "LastInventoryDate": "2012-03-21T22:06:51.218Z", "NumberOfArchives": 0, "SizeInBytes": 0, "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault2", "VaultName": "examplevault2" } ] }

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。