ジョブのリスト表示 (GET jobs) - Amazon S3 Glacier

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ジョブのリスト表示 (GET jobs)

説明

このオペレーションは、進行中および最近終了したジョブを含む、ボールトに対するジョブを一覧表示します。

注記

Amazon S3 Glacier (S3 Glacier) では、最近完了したジョブを削除する前に一定期間保持しますが、最終的には完了したジョブを削除します。完了したジョブの出力を取得できます。ジョブは完了後に一定期間保持されるため、ジョブの完了通知を見落とした場合や、最初のダウンロードの試行が失敗した場合に、ジョブの出力を取得できます。たとえば、アーカイブをダウンロードするために、アーカイブの取得ジョブを開始したとします。ジョブの完了後、そのアーカイブのダウンロードを開始しましたが、ネットワークエラーが発生しました。このシナリオでは、ジョブが存在する限り、再試行によりそのアーカイブをダウンロードできます。

List Jobs オペレーションは、ページ分割をサポートしています。常にレスポンスの Marker フィールドを確認する必要があります。それ以上表示するジョブがなくなると、Marker フィールドは null に設定されます。リストするジョブがまだある場合、Marker フィールドは Null 以外の値に設定され、これを使用してリストのページ分割を続行できます。特定のジョブで開始されるジョブのリストを返すには、marker リクエストパラメータを、前の Marker リクエストから取得した、そのジョブの List Jobs 値に設定します。

リクエストで limit パラメータを指定して、レスポンスで返されるジョブ数の最大の制限を設定することができます。デフォルトの上限は 50 です。返されるジョブの数は、上限を下回ることはあっても、上限を上回ることはありません。

さらに、オプションの statuscode パラメータと completed パラメータのいずれかまたは両方を指定することで、返されるジョブリストをフィルタすることができます。statuscode パラメータでは、InProgressSucceededFailed のいずれかのステータスと一致するジョブのみを返すように指定できます。completed パラメータでは、完了済みのジョブ (true) または未完了のジョブ (false) のみを返すように指定できます。

リクエスト

構文

各タイプのジョブのリストを返すには、ボールトの GET サブリソースの URI に jobs リクエストを送信します。

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

注記

-AccountIdvalueAWS アカウントボールトを所有するアカウントの ID。AWS アカウント ID、または Amazon S3 Glacier がリクエストの署名に使用した認証情報に関連する AWS アカウント ID を使用している場合はオプションで`-`「-」のどちらかを指定できます。アカウント ID を使用する場合は、ID にハイフン ('-') を含めないでください。

リクエストパラメータ

[Name] (名前) 説明 必須
completed

返すジョブの状態。true または false を指定できます。

Type: [Boolean] (ブール値)

制約: なし

いいえ
limit

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

Type: 文字列

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

いいえ
marker

ジョブのリスト表示を開始するジョブを指定する、ページ分割に使用される不透明な文字列。marker 値は、前の List Jobs レスポンスから取得します。前の marker リクエストで開始された結果のページ分割を継続する場合は、List Jobs を含めるだけで構いません。

Type: 文字列

制約: なし

いいえ
statuscode

返すジョブのステータスのタイプ。

Type: 文字列

制約: 次のいずれかの値です。InProgress,Succeeded, またはFailed

いいえ

リクエストヘッダー

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

リクエスト本文

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

レスポンス

構文

HTTP/1.1 200 OK x-amzn-RequestId: x-amzn-RequestId Date: Date Location: Location Content-Type: application/json Content-Length: Length { "JobList": [ { "Action": "string", "ArchiveId": "string", "ArchiveSHA256TreeHash": "string", "ArchiveSizeInBytes": number, "Completed": boolean, "CompletionDate": "string", "CreationDate": "string", "InventoryRetrievalParameters": { "EndDate": "string", "Format": "string", "Limit": "string", "Marker": "string", "StartDate": "string" }, "InventorySizeInBytes": number, "JobDescription": "string", "JobId": "string", "JobOutputPath": "string", "OutputLocation": { "S3": { "AccessControlList": [ { "Grantee": { "DisplayName": "string", "EmailAddress": "string", "ID": "string", "Type": "string", "URI": "string" }, "Permission": "string" } ], "BucketName": "string", "CannedACL": "string", "Encryption": { "EncryptionType": "string", "KMSContext": "string", "KMSKeyId": "string" }, "Prefix": "string", "StorageClass": "string", "Tagging": { "string": "string" }, "UserMetadata": { "string": "string" } } }, "RetrievalByteRange": "string", "SelectParameters": { "Expression": "string", "ExpressionType": "string", "InputSerialization": { "csv": { "Comments": "string", "FieldDelimiter": "string", "FileHeaderInfo": "string", "QuoteCharacter": "string", "QuoteEscapeCharacter": "string", "RecordDelimiter": "string" } }, "OutputSerialization": { "csv": { "FieldDelimiter": "string", "QuoteCharacter": "string", "QuoteEscapeCharacter": "string", "QuoteFields": "string", "RecordDelimiter": "string" } } }, "SHA256TreeHash": "string", "SNSTopic": "string", "StatusCode": "string", "StatusMessage": "string", "Tier": "string", "VaultARN": "string" } ], "Marker": "string" }

レスポンスヘッダー

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

レスポンス本文

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

JobList

ジョブオブジェクトのリスト。各ジョブオブジェクトには、そのジョブを説明するメタデータが含まれます。

Type: 配列GlacierJobDescriptionオブジェクト

Marker

結果のページ分割をどこから継続するかを表す不透明な文字列。リストに含まれるジョブをさらに取得するには、新しいmarker リクエストで List Jobs 値を使用します。リスト表示するジョブがそれ以上存在しない場合、この値は null です。

Type: 文字列

エラー

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

以下の例は、ボールトジョブに関する情報を返す方法を示しています。最初の例では 2 つのジョブのリストを返し、2 番目の例ではジョブのサブセットを返します。

例: すべてのジョブを返す

リクエストの例

次の GET リクエストでは、ボールトのジョブを返します。

GET /-/vaults/examplevault/jobs 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

レスポンスの例

次のレスポンスには、アーカイブの取得ジョブおよびインベントリの取得ジョブが含まれています。インベントリの取得ジョブには、ボールトインベントリの取得のページ分割を継続する場合に使用するマーカーが含まれています。レスポンスでは、Marker フィールドが null に設定され、表示するジョブがそれ以上ないことを示しています。

HTTP/1.1 200 OK x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q Date: Wed, 10 Feb 2017 12:00:00 GMT Content-Type: application/json Content-Length: 1444 { "JobList": [ { "Action": "ArchiveRetrieval", "ArchiveId": "BDfaUQul0dVzYwAMr8YSa_6_8abbhZq-i1oT69g8ByClfJyBgAGBkWl2QbF5os851P7Y7KdZDOHWJIn4rh1ZHaOYD3MgFhK_g0oDPesW34uHQoVGwoIqubf6BgUEfQm_wrU4Jlm3cA", "ArchiveSizeInBytes": 1048576, "ArchiveSHA256TreeHash": "25499381569ab2f85e1fd0eb93c5406a178ab77c5933056eb5d6e7d4adda609b", "Completed": true, "CompletionDate": "2012-05-01T00:00:09.304Z", "CreationDate": "2012-05-01T00:00:06.663Z", "InventorySizeInBytes": null, "JobDescription": null, "JobId": "hDe9t9DTHXqFw8sBGpLQQOmIM0-JrGtu1O_YFKLnzQ64548qJc667BRWTwBLZC76Ygy1jHYruqXkdcAhRsh0hYv4eVRU", "RetrievalByteRange": "0-1048575", "SHA256TreeHash": "25499381569ab2f85e1fd0eb93c5406a178ab77c5933056eb5d6e7d4adda609b", "SNSTopic": null, "StatusCode": "Succeeded", "StatusMessage": "Succeeded", "Tier": "Bulk", "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" }, { "Action": "InventoryRetrieval", "ArchiveId": null, "ArchiveSizeInBytes": null, "ArchiveSHA256TreeHash": null, "Completed": true, "CompletionDate": "2013-05-11T00:25:18.831Z", "CreationDate": "2013-05-11T00:25:14.981Z", "InventorySizeInBytes": 1988, "JobDescription": null, "JobId": "2cvVOnBL36btzyP3pobwIceiaJebM1bx9vZOOUtmNAr0KaVZ4WkWgVjiPldJ73VU7imlm0pnZriBVBebnqaAcirZq_C5", "RetrievalByteRange": null, "SHA256TreeHash": null, "SNSTopic": null, "StatusCode": "Succeeded", "StatusMessage": "Succeeded", "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" "InventoryRetrievalParameters": { "StartDate": "2013-11-12T13:43:12Z", "EndDate": "2013-11-20T08:12:45Z", "Limit": "120000", "Format": "JSON", "Marker": "vyS0t2jHQe5qbcDggIeD50chS1SXwYMrkVKo0KHiTUjEYxBGCqRLKaiySzdN7QXGVVV5XZpNVG67pCZ_uykQXFMLaxOSu2hO_-5C0AtWMDrfo7LgVOyfnveDRuOSecUo3Ueq7K0" } ], "Marker": null }

例: ジョブの部分的なリストを返す

リクエストの例

次の GET リクエストでは、marker パラメータで指定されたジョブを返します。limit パラメータを に設定すると、最大 2 個のジョブを返すように指定されます。2

GET /-/vaults/examplevault/jobs?marker=HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID&limit=2 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 つのジョブと、ジョブリストのページ分割を続行するために使用できる Null 以外の値に設定された Marker フィールドを示しています。

HTTP/1.1 200 OK x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q Date: Wed, 10 Feb 2017 12:00:00 GMT Content-Type: application/json Content-Length: 1744 { "JobList": [ { "Action": "ArchiveRetrieval", "ArchiveId": "58-3KpZfcMPUznvMZNPaKyJx9wODCsWTnqcjtx2CjKZ6b-XgxEuA8yvZOYTPQfd7gWR4GRm2XR08gcnWbLV4VPV_kDWtZJKi0TFhKKVPzwrZnA4-FXuIBfViYUIVveeiBE51FO4bvg", "ArchiveSizeInBytes": 8388608, "ArchiveSHA256TreeHash": "106086b256ddf0fedf3d9e72f461d5983a2566247ebe7e1949246bc61359b4f4", "Completed": true, "CompletionDate": "2012-05-01T00:25:20.043Z", "CreationDate": "2012-05-01T00:25:16.344Z", "InventorySizeInBytes": null, "JobDescription": "aaabbbccc", "JobId": "s4MvaNHIh6mOa1f8iY4ioG2921SDPihXxh3Kv0FBX-JbNPctpRvE4c2_BifuhdGLqEhGBNGeB6Ub-JMunR9JoVa8y1hQ", "RetrievalByteRange": "0-8388607", "SHA256TreeHash": "106086b256ddf0fedf3d9e72f461d5983a2566247ebe7e1949246bc61359b4f4", "SNSTopic": null, "StatusCode": "Succeeded", "StatusMessage": "Succeeded", "Tier": "Bulk", "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" }, { "Action": "ArchiveRetrieval", "ArchiveId": "2NVGpf83U6qB9M2u-Ihh61yoFLRDEoh7YLZWKBn80A2i1xG8uieBwGjAr4RkzOHA0E07ZjtI267R03Z-6Hxd8pyGQkBdciCSH1-Lw63Kx9qKpZbPCdU0uTW_WAdwF6lR6w8iSyKdvw", "ArchiveSizeInBytes": 1048576, "ArchiveSHA256TreeHash": "3d2ae052b2978727e0c51c0a5e32961c6a56650d1f2e4ceccab6472a5ed4a0", "Completed": true, "CompletionDate": "2012-05-01T16:59:48.444Z", "CreationDate": "2012-05-01T16:59:42.977Z", "InventorySizeInBytes": null, "JobDescription": "aaabbbccc", "JobId": "CQ_tf6fOR4jrJCL61Mfk6VM03oY8lmnWK93KK4gLig1UPAbZiN3UV4G_5nq4AfmJHQ_dOMLOX5k8ItFv0wCPN0oaz5dG", "RetrievalByteRange": "0-1048575", "SHA256TreeHash": "3d2ae052b2978727e0c51c0a5e32961c6a56650d1f2e4ceccab6472a5ed4a0", "SNSTopic": null, "StatusCode": "Succeeded", "StatusMessage": "Succeeded", "Tier": "Standard", "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" } ], "Marker": "CQ_tf6fOR4jrJCL61Mfk6VM03oY8lmnWK93KK4gLig1UPAbZiN3UV4G_5nq4AfmJHQ_dOMLOX5k8ItFv0wCPN0oaz5dG" }