描述任務 (GET JobID)

描述

此操作傳回您之前啟動任務的相關資訊，包括任務啟動日期、啟動任務的使用者、任務狀態碼/訊息，以及在 Amazon S3 Glacier (S3 Glacier) 完成任務後要通知的 Amazon Simple Notification Service (Amazon SNS) 主題。如需有關啟動任務的詳細資訊，請參閱 啟動 Job (POST工作)。

注意

此操作可讓您檢查任務的狀態。但是，我們強烈建議您設定 Amazon SNS 主題，並在啟動任務請求中指定該主題，以便在完成任務後，S3 Glacier 可以通知該主題。

S3 Glacier 完成任務後，任務 ID 至少在 24 小時內不會過期。

請求

語法

若要取得有關任務時的資訊，可以使用 HTTP GET 方法，並將請求範圍限定於特定任務。請注意，相對 URI 路徑與啟動任務時 S3 Glacier 傳回給您的路徑是相同的。

GET /AccountID/vaults/VaultName/jobs/JobID HTTP/1.1
Host: glacier.Region.amazonaws.com
Date: date
Authorization: signatureValue
x-amz-glacier-version: 2012-06-01

注意

此 AccountId 值是擁有該文件庫之帳戶的 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性使用 '-' (連字號)，在這種情況下，Amazon S3 會使用與用於簽署請求之憑證關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

注意

在請求中，如果您省略 JobID，該回應將傳回在指定文件庫上的所有作用中任務的清單。如需有關列出任務的詳細資訊，請參閱 列出工作 (GET 工作)。

請求參數

此操作不使用請求參數。

請求標頭

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 常見請求標題。

請求主體

此操作沒有請求內文。

回應

語法

HTTP/1.1 201 Created
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: Length

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

回應標頭

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 常見回應標頭。

回應內文

回應內文包含以下 JSON 欄位。

Action

工作類型。它是 ArchiveRetrieval、InventoryRetrieval 或 Select。

類型：字串

封存

針對選擇或封存擷取任務請求的封存 ID。否則，此欄位為 null。

類型：字串

ArchiveSHA256TreeHash

用於封存任務的整個封存的 SHA256 樹狀雜湊。對於庫存擷取作業，此欄位為 null。

類型：字串

ArchiveSizeInBytes

對於 ArchiveRetrieval 任務，這是請求下載的封存的大小，以位元組為單位。對於 InventoryRetrieval 任務，值為 null。

類型：數字

已完成

工作狀態。當封存或庫存擷取任務完成後，您可以使用 「取得任務輸出」 (GET 輸出) 獲取任務的輸出。

類型：布林值

CompletionDate

任務請求完成的國際標準時間 (UTC) 的時間。當任務正在進行時，該值為空。

類型：字串

CreationDate

建立任務所需的 UTC 時間。

類型：ISO 8601 日期格式的字串表示法，例如，2013-03-20T17:03:43.221Z。

InventoryRetrievalParameters

用於各種庫存擷取的輸入參數。

類型：InventoryRetrievalJobInput物件

InventorySizeInBytes

對於 InventoryRetrieval 任務，這是請求下載的庫存的大小，以位元組為單位。對於 ArchiveRetrieval 或 Select 任務，值為 null。

類型：數字

JobDescription

當您啟動的任務所提供的任務說明。

類型：字串

JobId

在 S3 Glacier 中識別任務的 ID。

類型：字串

JobOutputPath

包含任務輸出位置。

類型：字串

OutputLocation

一個物件，其中包含有關儲存選取任務結果和錯誤的位置的資訊。

類型：OutputLocation物件

RetrievalByteRange

用於封存擷取任務的擷取位元組範圍，格式為「StartByteValue-EndByteValue。」 如果封存擷取中沒有指定範圍, 則擷取整個封存，也就 StartByteValue 等於 0，而 EndByteValue 等於封存的大小減去 1。對於庫存擷取或選擇作業，此欄位為 null。

類型：字串

SelectParameters

一個物件，其中包含有關用於選擇的參數的資訊。

類型：SelectParameters物件

SHA256TreeHash

所請求的封存範圍的 SHA256 樹狀雜湊值。如果對封存的 啟動 Job (POST工作) 請求指定了樹狀雜湊值的範圍，則此欄位會傳回一個值。如需關於封存範圍擷取的樹狀雜湊值的詳細資訊，請參閱 下載資料時接收檢查總和。

對於擷取整個封存的特定案例，此值與 ArchiveSHA256TreeHash 值相同。

此欄位在以下情況下為 null：

• 封存擷取任務所指定的範圍不符合樹狀雜湊。

• 指定與整個封存和任務狀態相等的範圍的封存任務是 InProgress。

• 庫存任務

• 選取任務。

類型：字串

SNSTopic

接收通知的 Amazon SNS 主題。

類型：字串

StatusCode

表示任務狀態的代碼。

有效值：InProgress | Succeeded | Failed

類型：字串

StatusMessage

描述任務狀態的友善訊息。

類型：字串

層

用於選擇或封存擷取的資料存方案。

有效值：Bulk | Expedited | Standard

類型：字串

VaultARN

該任務是子資源的文件庫 Amazon Resource Name (ARN)。

類型：字串

錯誤

如需 Amazon S3 Glacier 例外和錯誤訊息的詳細資訊，請參閱錯誤回應。

範例

以下範例顯示對擷取封存的任務的請求。

範例請求：取得任務描述

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

回應範例

回應內文包含描述指定任務的 JSON。請注意，對於庫存擷取和封存擷取任務，JSON 欄位是相同的。但是，當欄位不適用於任務類型時，其值為 null。以下是封存擷取作業的範例回應。注意下列事項：

• Action欄位值為 ArchiveRetrieval。

• ArchiveSizeInBytes 欄位會顯示在封存擷取作業中請求的封存大小。

• ArchiveSHA256TreeHash 欄位顯示整個封存的 SHA256 樹狀雜湊。

• RetrievalByteRange 欄位顯示在啟動任務請求中請求的範圍。在這個範例中，請求整個封存。

• SHA256TreeHash 欄位顯示在啟動任務請求中請求的範圍的 SHA256 樹狀雜湊。在這個範例中，它與 ArchiveSHA256TreeHash 欄位相同，這表示請求整個封存。

• 此 InventorySizeInBytes 欄位值為 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: 419
{
  "Action": "ArchiveRetrieval",
  "ArchiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
  "ArchiveSizeInBytes": 16777216,
  "ArchiveSHA256TreeHash": "beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60",
  "Completed": false,
  "CompletionDate": null,
  "CreationDate": "2012-05-15T17:21:39.339Z",
  "InventorySizeInBytes": null,
  "JobDescription": "My ArchiveRetrieval Job",
  "JobId": "HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
  "RetrievalByteRange": "0-16777215",
  "SHA256TreeHash": "beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60",
  "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic",
  "StatusCode": "InProgress",
  "StatusMessage": "Operation in progress.",
  "Tier": "Bulk",
  "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
} 

以下是庫存擷取任務的範例回應。注意下列事項：

• Action欄位值為 InventoryRetrieval。

• ArchiveSizeInBytes、ArchiveSHA256TreeHash 和 RetrievalByteRange 欄位值為 null，因為這些欄位不適用於庫存擷取任務。

• InventorySizeInBytes 欄位值是 null ，因為該任務仍在進行中，而且要下載的庫存尚未完全準備好。如果任務在描述任務請求之前完成，則此欄位將給出輸出的大小。

{
   "Action": "InventoryRetrieval",
   "ArchiveId": null,
   "ArchiveSizeInBytes": null,
   "ArchiveSHA256TreeHash": null,
   "Completed": false,
   "CompletionDate": null,
   "CreationDate": "2012-05-15T23:18:13.224Z",
   "InventorySizeInBytes": null,
   "JobDescription": "Inventory Description",
   "JobId": "HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
   "RetrievalByteRange": null,
   "SHA256TreeHash": null,
   "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic",
   "StatusCode": "InProgress",
   "StatusMessage": "Operation in progress.",
   "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
}

以下是已完成的清查擷取任務的範例回應，其中包含用來持續對文件庫清查擷取進行分頁的標記。

{ 
    "Action": "InventoryRetrieval", 
    "ArchiveId": null, 
    "ArchiveSHA256TreeHash": null, 
    "ArchiveSizeInBytes": null, 
    "Completed": true, 
    "CompletionDate": "2013-12-05T21:51:13.591Z", 
    "CreationDate": "2013-12-05T21:51:12.281Z", 
    "InventorySizeInBytes": 777062, 
    "JobDescription": null, 
    "JobId": "sCC2RZNBF2nildYD_roe0J9bHRdPQUbDRkmTdg-mXi2u3lc49uW6TcEhDF2D9pB2phx-BN30JaBru7PMyOlfXHdStzu8", 
    "NextInventoryRetrievalMarker": null, 
    "RetrievalByteRange": null, 
    "SHA256TreeHash": null, 
    "SNSTopic": null, 
    "StatusCode": "Succeeded", 
    "StatusMessage": "Succeeded", 
    "Tier": "Bulk",
    "VaultARN": "arn:aws:glacier-devo:us-west-2:836579025725:vaults/inventory-icecube-2", 
    "InventoryRetrievalParameters": {
        "StartDate": "2013-11-12T13:43:12Z",
        "EndDate": "2013-11-20T08:12:45Z", 
        "Limit": "120000",
        "Format": "JSON",
        "Marker": "vyS0t2jHQe5qbcDggIeD50chS1SXwYMrkVKo0KHiTUjEYxBGCqRLKaiySzdN7QXGVVV5XZpNVG67pCZ_uykQXFMLaxOSu2hO_-5C0AtWMDrfo7LgVOyfnveDRuOSecUo3Ueq7K0"
    },   
}

相關章節

• 「取得任務輸出」 (GET 輸出)

• Amazon S3 Glacier 的 Identity and Access Management