jobParameters - Amazon S3 Glacier

此页面仅适用于使用保管库的 S3 Glacier 服务的现有客户以及 2012 年以RESTAPI来的原始客户。

如果您正在寻找档案存储解决方案,我们建议您在亚马逊 S3、S3 Glacier 即时检索、S3 Glacier 灵活检索和 S3 Glacier Deep Archive Dee p Archive 中使用 S3 Glacier 存储类。要了解有关这些存储选项的更多信息,请参阅 Amazon S3 用户指南中的 S3 Glacier 存储类和使用 S3 Glacier 存储类的长期数据存储。这些存储类别使用 Amazon S3API,适用于所有区域,并且可以在 Amazon S3 控制台中进行管理。它们提供存储成本分析、存储镜头、高级可选加密功能等功能。

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

jobParameters

提供用于定义任务的选项。

目录

ArchiveId

您需要的档案的 ID。如果 Type 字段设置为 selectarchive-retrieval,则此字段是必需的。如果您为清单检索任务请求指定此字段,则会出现错误。

有效值:必须为您从之前发送到 Amazon S3 Glacier (S3 Glacier) 的请求获取的有效档案 ID。

类型:字符串

必需:如果 Type 设置为 selectarchive-retrieval,则是必需的。

描述

任务的可选描述。

有效值:描述的长度必须小于或等于 1024 字节。允许的字符为不含控制代码的 7 位 ASCII 字符,明确说来就是 ASCII 值为 32-126(十进制)或 0x20-0x7E(十六进制)的字符。

类型:字符串

必需:否

格式

(可选) 在启动任务以检索文件库清单时的输出格式。如果您要启动清单任务,并且不指定 Format 字段,则 JSON 为默认格式。

有效值CSV | JSON

类型:字符串

必需:否

InventoryRetrievalParameters

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

类型InventoryRetrievalJobInput 对象

必需:否

OutputLocation

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

类型OutputLocation 对象

必需:对于 select 任务是必需的。

RetrievalByteRange

用于检索 archive-retrieval 的字节范围,采用格式“StartByteValue-EndByteValue”。如果不指定此字段,则会检索整个档案。如果指定此字段,则字节范围必须以兆字节 (1024*1024) 对齐。兆字节对齐意味着 StartByteValue 必须可被 1 MB 整除,而且 EndByteValue 加 1 必须可被 1 MB 整除或者是指定为档案字节大小值减去 1 的档案的结尾。如果 RetrievalByteRange 没有以兆字节对齐,则此操作会返回 400 响应。

如果您为 inventory-retrievalselect 任务请求指定此字段,则会出现错误。

类型:字符串

必需:否

SelectParameters

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

类型SelectParameters 对象

必需:否

SNSTopic

任务完成并且输出已准备好供您下载时 S3 Glacier 向其发送通知的 Amazon SNS 主题的 Amazon 资源名称(ARN)。指定的主题会向其订阅者发布通知。

SNS 主题必须存在。如果不存在,则 S3 Glacier 不会为您创建该主题。此外,SNS 主题必须拥有允许创建任务的账户向主题发布消息的策略。有关 SNS 主题名称的信息,请参阅《Amazon Simple Notification Service API 参考》中的 CreateTopic

类型:字符串

必需:否

套餐

用于 select 或档案检索任务的层。Standard 是默认使用的值。

有效值: Expedited | Standard | Bulk

类型:字符串

必需:否

Type

任务类型。您可以启动 作业以对档案执行 select 查询、检索档案或获取文件库的清单。

有效值: select | archive-retrieval | inventory-retrieval

类型:字符串

必需:是

更多信息