描述任务(获取任务 ID) - Simple Storage Service(Amazon S3)Glacier
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

描述任务(获取任务 ID)

描述

此操作返回有关您之前启动的任务的信息,包括任务启动日期、启动任务的用户、任务状态代码/消息以及 Amazon S3 Glacier (S3 Glacier) 完成任务后要通知的亚马逊简单通知服务 (Amazon SNS) 主题。有关启动任务的更多信息,请参阅“启动作业(POST 作业)”。

注意

此操作可让您检查您的任务的状态。但是,我们强烈建议您设置 Amazon SNS 主题并在启动任务请求中指定该主题,以便 S3 Glacier 可以在任务完成后通知该主题。

任务 ID 在 S3 Glacier 完成任务后的至少 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值是拥有文件库的账户的Amazon Web Services 账户 ID。您可以指定Amazon Web Services 账户 ID,也可以选择单个 “-”(连字符),在这种情况下,Amazon S3 Glacier 使用与用于签署请求的证书关联的Amazon Web Services 账户 ID。如果您使用账户 ID,请勿在 ID 中包含任何连字符 ('-')。

注意

在该请求中,如果您省略 JobID,则响应会返回指定文件库中所有有效任务的列表。有关列出任务的更多信息,请参阅“列出任务(获取任务)”。

请求参数

此操作不使用请求参数。

请求标头

此操作仅使用所有操作通用的请求头。有关通用请求头的信息,请参阅常见请求标头

请求正文

此操作没有请求正文。

响应

语法

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

任务类型。它为 ArchiveRetrievalInventoryRetrievalSelect

类型:字符串

ArchiveId

为 select 或档案检索任务请求的档案 ID。否则,此字段为 null

类型:字符串

ArchiveshaTreeHash

档案取回任务的整个档案的 SHA256 树形哈希。对于清单取回任务,此字段为 null

类型:字符串

ArchiveSizeInBytes

对于 ArchiveRetrieval 任务,这是正在请求下载的档案的大小(以字节为单位)。对于 InventoryRetrieval 任务,该值为 null

类型:数字

已完成

任务状态。当档案或清单检索任务完成后,您将使用 获取任务输出(获取输出) 来获取任务的输出。

类型:布尔值

CompletionDate

任务请求完成时的通用协调时间 (UTC) 时间。当任务正在进行时,该值将为空。

类型:字符串

CreationDate

创建任务的 UTC 时间。

类型:例如,ISO 8601 日期格式的字符串表示形式2013-03-20T17:03:43.221Z

InventoryRetrievalParameters

用于范围清单检索的输入参数。

类型InventoryRetrievalJobInput 对象

InventorySizeInBytes

对于 InventoryRetrieval 任务,这是请求下载的清单的大小(以字节为单位)。对于 ArchiveRetrievalSelect 任务,该值为 null

类型:数字

JobDescription

您在启动任务时提供的任务描述。

类型:字符串

JobId

在 S3 Glacier 中识别任务的 ID。

类型:字符串

JobOutputPath

包含任务输出位置。

类型:字符串

OutputLocation

一个对象,其中包含有关 select 任务结果和错误的存储位置的信息。

类型OutputLocation 对象

RetrievalByteRange

存档检索任务的检索字节范围,格式为 “StartByteValue-” EndByteValue。如果您未在档案检索中指定范围,则检索整个档案;也StartByteValue等于 0,EndByteValue等于档案大小减去 1。对于清单检索或 select 任务,此字段为 null

类型:字符串

SelectParameters

一个对象,其中包含有关用于 select 的参数的信息。

类型SelectParameters 对象

SHA256TreeHash

档案请求范围的 SHA256 树形哈希值。如果档案的 启动作业(POST 作业) 请求指定了以树形哈希对齐的范围,则此字段会返回值。有关档案范围取回的树形哈希对齐的更多信息,请参阅“下载数据时接收校验和”。

对于取回整个档案时的特定情况,此值与 ArchiveSHA256TreeHash 值相同。

在以下情况中,此字段为 null

  • 指定未以树形哈希对齐的范围的档案取回任务。

  • 指定等于整个档案的范围并且任务状态为 InProgress 的档案任务。

  • 清单任务。

  • 选择任务。

类型:字符串

SNSTopic

接收通知的 Amazon SNS 主题。

类型:字符串

StatusCode

指示任务状态的代码。

有效值: InProgress | Succeeded | Failed

类型:字符串

StatusMessage

描述任务状态的友好消息。

类型:字符串

套餐

用于 select 或档案检索的数据访问。

有效值: Bulk | Expedited | Standard

类型:字符串

VaultARN

任务为其子资源的文件库的Amazon 资源名称 (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

  • ArchiveSizeInBytesArchiveSHA256TreeHashRetrievalByteRange 字段值为空,因为这些字段不适用于清单取回任务。

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