

 **此页面仅适用于使用文件库和 2012 年原始 REST API 的 Amazon Glacier 服务的现有客户。**

如果您正在寻找归档存储解决方案，建议使用 Amazon S3 中的 Amazon Glacier 存储类别 S3 Glacier Instant Retrieval、S3 Glacier Flexible Retrieval 和 S3 Glacier Deep Archive。要了解有关这些存储选项的更多信息，请参阅 [Amazon Glacier 存储类别](https://aws.amazon.com/s3/storage-classes/glacier/)。

Amazon Glacier（最初基于保管库的独立服务）不再接受新客户。Amazon Glacier 是一项独立的服务 APIs ，拥有自己的服务，可将数据存储在文件库中，不同于亚马逊 S3 和 Amazon S3 Glacier 存储类别。在 Amazon Glacier 中，您现有的数据将确保安全，并且可以无限期地访问。无需进行迁移。对于低成本、长期的存档存储， AWS 建议[使用 Amazon S3 Glacier 存储类别，这些存储类别](https://aws.amazon.com/s3/storage-classes/glacier/)基于S3存储桶 APIs、完全 AWS 区域 可用性、更低的成本和 AWS 服务集成，可提供卓越的客户体验。如果您希望加强功能，可以考虑使用我们的 [AWS 将数据从 Amazon Glacier 文件库传输到 Amazon S3 Glacier 存储类别的解决方案指南](https://aws.amazon.com/solutions/guidance/data-transfer-from-amazon-s3-glacier-vaults-to-amazon-s3/)，迁移到 Amazon S3 Glacier 存储类别。

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

# 在任务操作中使用的数据类型
<a name="api-data-types"></a>

以下是在 Amazon Glacier 中和任务操作一起使用的数据类型。

**Topics**
+ [CSVInput](api-CSVInput.md)
+ [CSVOutput](api-CSVOutput.md)
+ [加密](api-Encryption.md)
+ [GlacierJobDescription](api-GlacierJobDescription.md)
+ [授权](api-Grant.md)
+ [被授权者](api-Grantee.md)
+ [InputSerialization](api-InputSerialization.md)
+ [InventoryRetrievalJobInput](api-InventoryRetrievalJobInput.md)
+ [jobParameters](api-jobParameters.md)
+ [OutputLocation](api-OutputLocation.md)
+ [OutputSerialization](api-OutputSerialization.md)
+ [S3Location](api-S3Location.md)
+ [SelectParameters](api-SelectParameters.md)

# CSVInput
<a name="api-CSVInput"></a>

有关包含逗号分隔值 (CSV) 文件的信息。

## 目录
<a name="api-CSVInput-contents"></a>

**评论**  
单个字符，用于指示在行的开头出现该字符时应忽略该行。  
*类型*：字符串  
*必需*：否

**FieldDelimiter**  
单个字符，用于分隔记录中的各个字段。该字符必须是 `\n`、`\r` 或范围 32–126 中的 ASCII 字符。默认值为逗号 (`,`)。  
*类型*：字符串  
*默认值*：,  
*必需*：否

**FileHeaderInfo**  
一个值，描述如何处理输入中的第一行。  
*类型*：字符串  
*有效值*：`Use` \$1`Ignore` \$1`None`   
  
*必需*：否

**QuoteCharacter**  
用作转义字符的单个字符，其中字段分隔符是值的一部分。  
*类型*：字符串  
*必需*：否

**QuoteEscapeCharacter**  
单个字符，用于对已转义值内的引号字符进行转义。  
*类型*：字符串  
*必需*：否

**RecordDelimiter**  
单个字符，用于分隔各个记录。  
*类型*：字符串  
*必需*：否

## 更多信息
<a name="more-info-api-CSVInput"></a>

 
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# CSVOutput
<a name="api-CSVOutput"></a>

包含有关存储作业结果的逗号分隔值 (CSV) 格式的信息。

## 目录
<a name="api-CSVOutput-contents"></a>

**FieldDelimiter**  
单个字符，用于分隔记录中的各个字段。  
*类型*：字符串  
*必需*：否

**QuoteCharacter**  
用作转义字符的单个字符，其中字段分隔符是值的一部分。  
*类型*：字符串  
*必需*：否

**QuoteEscapeCharacter**  
单个字符，用于对已转义值内的引号字符进行转义。  
*类型*：字符串  
*必需*：否

**QuoteFields**  
一个值，指示是否所有输出字段都应包含在引号中。  
*有效值*：`ALWAYS` \$1`ASNEEDED`   
*类型*：字符串  
*必需*：否

**RecordDelimiter**  
单个字符，用于分隔各个记录。  
*类型*：字符串  
*必需*：否

## 更多信息
<a name="more-info-api-CSVOutput"></a>

 
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# 加密
<a name="api-Encryption"></a>

包含有关用于在 Amazon S3 中存储任务结果的加密的信息。

## 目录
<a name="api-Encryption-contents"></a>

**加密**。  
在 Amazon S3 中存储任务结果时使用的服务器端加密算法。默认值为无加密。  
*类型*：字符串  
*有效值*：`aws:kms` \$1`AES256`   
*必需*：否

**KMSContext**  
可选。如果加密类型是 `aws:kms,`，您可以使用此值为任务结果指定加密上下文。  
*类型*：字符串  
*必需*：否

**KMSKeyId**  
用于对象加密的 AWS Key Management Service (AWS KMS) 密钥 ID。  
*类型*：字符串  
*必需*：否

## 更多信息
<a name="more-info-api-Encryption"></a>

 
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# GlacierJobDescription
<a name="api-GlacierJobDescription"></a>

包含 Amazon Glacier（Amazon Glacier）任务的描述。

## 目录
<a name="api-GlacierJobDescription-contents"></a>

**Action**  
任务类型。它为 `ArchiveRetrieval`、`InventoryRetrieval` 或 `Select`。  
*类型*：字符串

**ArchiveId**  
为选择任务或档案检索任务请求的档案 ID。否则，此字段为 `null`。  
*类型*：字符串

**ArchiveSHA256TreeHash**  
档案检索操作的整个档案的 SHA256 树形哈希。对于清单检索任务，此字段为 `null`。  
*类型*：字符串

**ArchiveSizeInBytes**  
对于 `ArchiveRetrieval` 任务，这是正在请求下载的档案的大小（以字节为单位）。对于 `InventoryRetrieval` 任务，该值为 `null`。  
*类型*：数字

**Completed**  
如果任务已完成，则为 `true`；否则为 `false`。  
*类型*：布尔值

**CompletionDate**  
任务完成的日期。  
任务请求完成时的通用协调时间（UTC）时间。当任务正在进行时，该值将为空。  
*类型*：以 ISO 8601 日期格式表示的字符串，例如 `2013-03-20T17:03:43.221Z`。

**CreationDate**  
任务启动时的通用协调时间（UTC）日期。  
*类型*：以 ISO 8601 日期格式表示的字符串，例如 `2013-03-20T17:03:43.221Z`。

**InventoryRetrievalParameters**  
用于范围清单检索的输入参数。  
*类型*：[InventoryRetrievalJobInput](api-InventoryRetrievalJobInput.md) 对象

**InventorySizeInBytes**  
对于 `InventoryRetrieval` 任务，这是请求下载的清单的大小（以字节为单位）。对于 `ArchiveRetrieval` 或 `Select` 任务，该值为 `null`。  
*类型*：数字

**JobDescription**  
您在启动任务时提供的任务描述。  
*类型*：字符串

**JobId**  
标识 Amazon Glacier 中的任务的 ID。  
*类型*：字符串

**JobOutputPath**  
包含任务输出位置。  
*类型*：字符串

**OutputLocation**  
 一个对象，其中包含有关选择任务结果和错误的存储位置的信息。  
*类型*：[OutputLocation](api-OutputLocation.md) 对象

**RetrievalByteRange**  
档案检索任务所检索的字节范围，格式为“*StartByteValue*-*EndByteValue*”。如果没有在档案检索中指定范围，则检索整个档案，并且 *StartByteValue* 等于 0，*EndByteValue* 等于档案大小减去 1。对于清单检索任务，此字段为 `null`。  
*类型*：字符串

**SelectParameters**  
一个对象，其中包含有关用于选择任务的参数的信息。  
*类型*：[SelectParameters](api-SelectParameters.md) 对象

**SHA256TreeHash**  
档案请求范围的 SHA256 树形哈希值。如果档案的[启动任务（POST jobs）](api-initiate-job-post.md)请求指定了以树形哈希对齐的范围，则此字段会返回值。有关档案范围检索的树形哈希对齐的更多信息，请参阅[下载数据时接收校验和](checksum-calculations-range.md)。  
对于检索整个档案时的特定情况，此值与 `ArchiveSHA256TreeHash` 值相同。  
在以下情况中，此字段为 `null`：  
+ 指定未以树形哈希对齐的范围的档案检索任务。
+ 指定等于整个档案的范围并且任务状态为 `InProgress` 的档案任务。
+ 清单任务。
+ 选择任务。
*类型*：字符串

**SNSTopic**  
表示 Amazon SNS 主题的 Amazon 资源名称（ARN）；如果在任务启动（[启动任务（POST jobs）](api-initiate-job-post.md)）中配置了通知，则系统会向该主题发送任务完成或失败的通知。  
*类型*：字符串

**StatusCode**  
指示任务状态的代码。  
*有效值*：`InProgress` \$1 `Succeeded` \$1 `Failed`  
*类型*：字符串

**StatusMessage**  
任务状态消息。  
*类型*：字符串

**Tier**  
用于选择任务或档案检索任务的数据访问套餐。  
*有效值*：`Expedited` \$1`Standard` \$1`Bulk`  
*类型*：字符串

**VaultARN**  
任务为其子资源的文件库的 ARN。  
*类型*：字符串

## 更多信息
<a name="more-info-api-GlacierJobDescription"></a>
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# 授权
<a name="api-Grant"></a>

包含有关授权的信息。

## 目录
<a name="api-Grant-contents"></a>

**被授权者**  
被授权者。  
*类型*：[被授权者](api-Grantee.md) 对象  
*必需*：否

**权限**  
授予被授权者的权限。  
*类型*：字符串  
*有效值*: `FULL_CONTROL` \$1 `WRITE` \$1 `WRITE_ACP` \$1 `READ` \$1 `READ_ACP`  
*必需*：否

## 更多信息
<a name="more-info-api-Grant"></a>

 
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# 被授权者
<a name="api-Grantee"></a>

包含有关被授权者的信息。

## 目录
<a name="api-Grantee-contents"></a>

**DisplayName**  
被授权者的屏幕名称。  
*类型*：字符串  
*必需*：否

**EmailAddress**  
被授权者的电子邮件地址。  
*类型*：字符串  
*必需*：否

**ID**：  
被授权者的规范用户 ID。  
*类型*：字符串  
*必需*：否

**类型**  
被授权者的类型。  
*类型*：字符串  
*有效值*：`AmazonCustomerByEmail` \$1`CanonicalUser` \$1`Group`   
*必需*：否

**URI**  
被授权者组的 URI。  
*类型*：字符串  
*必需*：否

## 更多信息
<a name="more-info-api-Grantee"></a>

 
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# InputSerialization
<a name="api-InputSerialization"></a>

描述如何序列化档案。

## 目录
<a name="api-InputSerialization-contents"></a>

**CSV**  
一个对象，用于描述 CSV 编码对象的序列化。  
*类型*：[CSVInput](api-CSVInput.md) 对象  
*必需*：否

## 更多信息
<a name="more-info-api-InputSerialization"></a>

 
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# InventoryRetrievalJobInput
<a name="api-InventoryRetrievalJobInput"></a>

 提供用于指定范围清单检索任务的选项。

## 目录
<a name="api-InventoryRetrievalJobInput-contents"></a>

**EndDate**  
文件库清单检索的结束日期 (采用 UTC 时间格式)，在此日期之前创建的存档都包括在检索范围内。  
*有效值*：以 ISO 8601 日期格式 (`YYYY-MM-DDThh:mm:ssTZD`) 表示的字符串，以秒为单位，例如 `2013-03-20T17:03:43Z`。  
*类型*：字符串。以 ISO 8601 日期格式 (`YYYY-MM-DDThh:mm:ssTZD`) 表示的字符串，以秒为单位，例如 `2013-03-20T17:03:43Z`。  
*必需*：否

**格式**。  
 文件库清单列表的输出格式，在启动任务以检索文件库清单时通过 [启动任务（POST jobs）](api-initiate-job-post.md) 请求进行设置。  
*有效值*：`CSV` \$1`JSON`   
*必需*：否  
*类型*：字符串

**限制**  
 每个文件库清单检索请求可以返回的最大清单项目数。  
*有效值*：大于或等于 1 的整数值。  
*类型*：字符串  
*必需*：否

**Marker**  
 表示从何处继续对结果进行分页的不透明字符串。您可以在新 `Initiate Job` 请求中使用此标记获取其他清单项目。如果没有更多清单项目，则此值为 null。  
*类型*：字符串  
*必需*：否

**StartDate**  
文件库清单检索的开始日期 (采用 UTC 时间格式)，包含当日或之后创建的档案。  
*有效值*：以 ISO 8601 日期格式 (`YYYY-MM-DDThh:mm:ssTZD`) 表示的字符串，以秒为单位，例如 `2013-03-20T17:03:43Z`。  
*类型*：字符串。以 ISO 8601 日期格式 (`YYYY-MM-DDThh:mm:ssTZD`) 表示的字符串，以秒为单位，例如 `2013-03-20T17:03:43Z`。  
*必需*：否

## 更多信息
<a name="more-info-api-InventoryRetrievalJobInput"></a>
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# jobParameters
<a name="api-jobParameters"></a>

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

## 目录
<a name="api-jobParameters-contents"></a>

**ArchiveId**  
您需要的档案的 ID。如果 `Type` 字段设置为 `select` 或 `archive-retrieval`，则此字段是必需的。如果您为清单检索任务请求指定此字段，则会出现错误。  
*有效值*：必须为您从之前发送到 Amazon Glacier（Amazon Glacier）的请求获取的有效档案 ID。  
*类型*：字符串  
*是否必需*：如果 `Type` 设置为 `select` 或 `archive-retrieval`，则是必需的。

**描述**  
任务的可选描述。  
*有效值*：描述的长度必须小于或等于 1024 字节。允许的字符为不含控制代码的 7 位 ASCII 字符，明确说来就是 ASCII 值为 32-126（十进制）或 0x20-0x7E（十六进制）的字符。  
*类型*：字符串  
*是否必需*：否

**Format**  
（可选）在启动任务以检索文件库清单时的输出格式。如果您要启动清单任务，并且不指定 `Format` 字段，则 JSON 为默认格式。  
*有效值*：`CSV` \$1 `JSON`   
*类型*：字符串  
*是否必需*：否

**InventoryRetrievalParameters**  
用于范围清单检索的输入参数。  
*类型*：[InventoryRetrievalJobInput](api-InventoryRetrievalJobInput.md) 对象  
*是否必需*：否

**OutputLocation**  
 一个对象，其中包含有关选择任务结果的存储位置的信息。  
*类型*：[OutputLocation](api-OutputLocation.md) 对象  
*是否必需*：对于 `select` 任务是必需的。

**RetrievalByteRange**  
用于检索 `archive-retrieval` 的字节范围，采用格式“*StartByteValue*-*EndByteValue*”。如果不指定此字段，则会检索整个档案。如果指定此字段，则字节范围必须以兆字节（1024\$11024）对齐。兆字节对齐意味着 *StartByteValue* 必须可被 1 MB 整除，而且 *EndByteValue* 加 1 必须可被 1 MB 整除或者是指定为档案字节大小值减去 1 的档案的结尾。如果 **RetrievalByteRange** 没有以兆字节对齐，则此操作会返回 `400` 响应。  
如果您为 `inventory-retrieval` 或 `select` 任务请求指定此字段，则会出现错误。  
*类型*：字符串  
*是否必需*：否

**SelectParameters**  
一个对象，其中包含有关用于选择任务的参数的信息。  
*类型*：[SelectParameters](api-SelectParameters.md) 对象  
*是否必需*：否

**SNSTopic**  
任务完成并且输出已准备好供您下载时 Amazon Glacier 向其发送通知的 Amazon SNS 主题的 Amazon 资源名称（ARN）。指定的主题会向其订阅者发布通知。  
SNS 主题必须存在。如果不存在，则 Amazon Glacier 不会为您创建该主题。此外，SNS 主题必须拥有允许创建任务的账户向主题发布消息的策略。有关 SNS 主题名称的信息，请参阅《Amazon Simple Notification Service API 参考》****中的 [CreateTopic](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html)。  
*类型*：字符串  
*是否必需*：否

**Tier**  
用于选择任务或档案检索任务的套餐。默认值为 `Standard`。  
*有效值*：`Expedited` \$1`Standard` \$1 `Bulk`  
*类型*：字符串  
*是否必需*：否 

**Type**  
任务类型。您可以启动任务以对档案执行选择查询、检索档案或获取文件库的清单。  
*有效值*：`select` \$1 `archive-retrieval` \$1 `inventory-retrieval`   
*类型*：字符串  
*是否必需*：是

## 更多信息
<a name="more-info-api-jobParameters"></a>
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# OutputLocation
<a name="api-OutputLocation"></a>

 包含有关作业结果和错误的存储位置的信息。

## 目录
<a name="api-OutputLocation-contents"></a>

**S3**  
一个对象，描述用于接收还原请求结果的 Amazon S3 位置。  
*类型*：[S3Location](api-S3Location.md)  
*必需*：是

## 更多信息
<a name="more-info-api-OutputLocation"></a>
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# OutputSerialization
<a name="api-OutputSerialization"></a>

描述如何序列化输出。

## 目录
<a name="api-OutputSerialization-contents"></a>

**CSV**  
一个对象，描述逗号分隔值 (CSV) 编码的查询结果的序列化。  
*类型*：[CSVOutput](api-CSVOutput.md) 对象  
*必需*：否

## 更多信息
<a name="more-info-api-OutputSerialization"></a>

 
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# S3Location
<a name="api-S3Location"></a>

 包含有关任务结果在 Amazon S3 中的存储位置的信息。

## 目录
<a name="api-S3Location-contents"></a>

**AccessControlList**  
控制对存储结果的访问权限的授权列表。  
*类型*：[授权](api-Grant.md) 对象数组  
*必需*：否

**BucketName**  
存储了任务结果的 Amazon S3 存储桶的名称。该存储桶必须与包含输入档案对象的文件库位于同一个 AWS 区域中。  
*类型*：字符串  
*必需*：是

**CannedACL**  
要应用于任务结果的标准访问控制列表 (ACL)。  
*类型*：字符串  
*有效值*：`private` \$1`public-read` \$1`public-read-write` \$1`aws-exec-read` \$1`authenticated-read` \$1`bucket-owner-read` \$1`bucket-owner-full-control`   
*必需*：否

**加密**。  
一个对象，其中包含有关用于在 Amazon S3 中存储任务结果的加密的信息。  
*类型*：[加密](api-Encryption.md) 对象  
*必需*：否

**Prefix**  
在此请求的结果前面添加的前缀。前缀的最大长度是 512 字节。  
*类型*：字符串  
*必需*：是

**StorageClass**  
用于存储任务结果的存储类别。  
*类型*：字符串  
*有效值*：`STANDARD` \$1`REDUCED_REDUNDANCY` \$1`STANDARD_IA`   
*必需*：否

**标记**  
应用于任务结果的标签集。  
*类型*：字符串到字符串映射  
*必需*：否

**UserMetadata**  
在 Amazon S3 中与任务结果一起存储的元数据的映射。  
*类型*：字符串到字符串映射  
*必需*：否

## 更多信息
<a name="more-info-api-S3Location"></a>

 
+ [启动任务（POST jobs）](api-initiate-job-post.md)

# SelectParameters
<a name="api-SelectParameters"></a>

包含有关用于 select 的参数的信息。

## 目录
<a name="api-SelectParameters-contents"></a>

**Expression**  
用于选择对象的表达式。该表达式不得超过 128,000 个字符的配额。  
*类型*：字符串  
*必需*：是

**ExpressionType**  
所提供表达式的类型，例如 `SQL`。  
*有效值*：`SQL`  
*类型*：字符串  
*必需*：是

**InputSerialization**  
描述 select 中对象的序列化格式。  
*类型*：[InputSerialization](api-InputSerialization.md) 对象  
*必需*：否

**OutputSerialization**  
描述如何序列化 select 任务的结果。  
*必需*：否  
*类型*：[OutputSerialization](api-OutputSerialization.md) 对象

## 更多信息
<a name="more-info-api-SelectParameters"></a>

 
+ [启动任务（POST jobs）](api-initiate-job-post.md)