Mencantumkan Tugas (GET jobs)

Deskripsi

Operasi ini mencantumkan daftar tugas untuk vault, termasuk tugas yang sedang berlangsung dan tugas yang baru saja selesai.

catatan

Amazon S3 Glacier (S3 Glacier) mempertahankan tugas yang baru saja selesai selama periode sebelum menghapusnya; Namun, akhirnya menghapus tugas yang sudah selesai. Output dari tugas yang diselesaikan dapat diambil. Mempertahankan tugas yang selesai untuk jangka waktu tertentu setelah selesai memungkinkan Anda mendapatkan output tugas jika Anda melewatkan notifikasi penyelesaian tugas, atau upaya pertama Anda untuk mengunduhnya gagal. Misalnya, Anda memulai tugas pengambilan arsip untuk mengunduh arsip. Setelah tugas selesai, Anda mulai mengunduh arsip, tetapi mengalami kesalahan jaringan. Dalam skenario ini, Anda dapat mencoba lagi dan mengunduh arsip sewaktu tugas ada.

Operasi List Jobs mendukung pemberian nomor halaman. Anda harus selalu memeriksa bidang Marker respons. Jika tidak ada tugas lainnya yang dicantumkan, bidang Marker diatur ke null. Jika ada tugas lainnya yang dicantumkan, bidang Marker diatur ke nilai non-nol, yang dapat Anda gunakan untuk melanjutkan pemberian nomor halaman daftar. Untuk mengembalikan daftar tugas yang dimulai pada tugas tertentu, atur parameter permintaan marker ke nilai Marker untuk tugas yang Anda peroleh dari permintaan List Jobs sebelumnya.

Anda juga dapat menetapkan batas maksimum untuk jumlah tugas yang dikembalikan dalam respons dengan menentukan parameter limit dalam permintaan. Batas default adalah 50. Jumlah tugas yang dikembalikan mungkin kurang dari batas, tetapi jumlah tugas yang dikembalikan tidak pernah melebihi batas.

Selain itu, Anda dapat memfilter daftar tugas yang dikembalikan dengan menentukan parameter statuscode opsional atau parameter completed, atau pun keduanya. Dengan menggunakan parameter statuscode, Anda dapat menentukan untuk hanya mengembalikan tugas yang cocok dengan status InProgress, Succeeded, atau Failed. Dengan menggunakan parameter completed, Anda dapat menentukan untuk hanya mengembalikan tugas yang sudah selesai (true) atau tugas yang belum selesai (false).

Permintaan

Sintaksis

Untuk mengembalikan daftar tugas dari semua tipe, kirim permintaan GET ke URI dari subsumber daya jobs vault.

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

catatan

Nilai AccountId adalah ID Akun AWS dari akun yang memiliki vault. Anda dapat menentukan ID Akun AWS atau secara opsional satu '-' (tanda hubung), dalam hal ini, Amazon S3 Glacier menggunakan ID Akun AWS yang terkait dengan kredensial yang digunakan untuk menandatangani permintaan. Jika Anda menggunakan ID akun, jangan sertakan tanda hubung ('-') di ID.

Parameter Permintaan

Nama	Deskripsi	Wajib
completed	Status tugas yang dikembalikan. Anda dapat menentukan true atau false. Tipe: Boolean Batasan: Tidak Ada	Tidak
limit	Jumlah maksimum tugas yang dikembalikan. Batas default adalah 50. Jumlah tugas yang dikembalikan mungkin kurang dari batas yang ditentukan, tetapi jumlah tugas yang dikembalikan tidak pernah melebihi batas. Tipe: String Batasan: Nilai bilangan bulat minimum 1. Nilai bilangan bulat maksimum sebesar 50.	Tidak
marker	String buram yang digunakan untuk pemberian nomor halaman yang menentukan tugas tempat cantuman bagian harus dimulai. Anda mendapatkan nilai marker dari respons List Jobs sebelumnya. Anda harus menyertakan marker jika Anda melanjutkan pemberian nomor halaman dari hasil yang dimulai dalam permintaan List Jobs sebelumnya. Tipe: String Batasan: Tidak Ada	Tidak
statuscode	Tipe status tugas yang dikembalikan. Tipe: String Batasan: Salah satu nilai InProgress, Succeeded, atau Failed.	Tidak

Header Permintaan

Operasi ini hanya menggunakan header respons yang umum untuk sebagian besar respons. Untuk informasi tentang header permintaan umum, lihat Header Respons Umum.

Isi Permintaan

Operasi ini tidak memiliki isi permintaan.

Respons

Sintaksis

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

Header Respons

Operasi ini hanya menggunakan header respons yang umum untuk sebagian besar respons. Untuk informasi tentang header permintaan umum, lihat Header Respons Umum.

Isi Respons

Isi respons berisi bidang JSON berikut.

JobList

Daftar objek tugas. Setiap objek tugas berisi metadata yang menggambarkan tugas.

Tipe: Array objek GlacierJobDescription

Penanda

String buram yang mewakili tempat untuk melanjutkan pemberian nomor halaman hasil. Anda menggunakan nilai marker dalam permintaan List Jobs baru untuk mendapatkan lebih banyak tugas dalam daftar. Jika tidak ada tugas lainnya, nilai ini adalah null.

Tipe: String

Kesalahan

Untuk informasi tentang pengecualian dan pesan kesalahan Amazon S3 Glacier, lihat Respons Kesalahan.

Contoh

Contoh berikut menunjukkan cara mengembalikan informasi tentang tugas vault. Contoh pertama mengembalikan daftar dua tugas, dan contoh kedua mengembalikan subset tugas.

Contoh: Mengembalikan Semua Tugas

Contoh Permintaan

Permintaan GET berikut mengembalikan tugas untuk vault.

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		

Contoh Respons

Respons berikut menyertakan tugas pengambilan arsip dan tugas pengambilan inventaris yang berisi penanda yang digunakan untuk melanjutkan pemberian nomor halaman dari pengambilan inventaris vault. Respons juga menunjukkan bidang Marker yang diatur kenull, yang menunjukkan tidak ada lagi tugasyang dicantumkan.

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  
}

Contoh: Mengembalikan Daftar Sebagian Tugas

Contoh Permintaan

Permintaan GET berikut mengembalikan tugas yang ditentukan oleh parameter marker. Mengatur parameter limit sebagai 2 menetapkan bahwa hingga dua tugas dikembalikan.

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

Contoh Respons

Respons berikut menunjukkan dua tugas yang dikembalikan dan bidang Marker yang diatur ke nilai non-nol yang dapat digunakan untuk melanjutkan pemberian nomor halaman daftar tugas.

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

Bagian Terkait

• Mendeskripsikan Tugas (GET JobID)

• Identity and Access Management untuk Amazon S3 Glacier