

 **此頁面僅適用於使用 Vaults 和 2012 年原始 REST API 的 Amazon Glacier 服務的現有客戶。**

如果您要尋找封存儲存解決方案，建議您在 Amazon Glacier Instant Retrieval、S3 Glacier Flexible Retrieval 和 S3 Glacier Deep Archive 中使用 Amazon Glacier 儲存類別。 Amazon S3 若要進一步了解這些儲存選項，請參閱 [Amazon Glacier 儲存類別](https://aws.amazon.com/s3/storage-classes/glacier/)。

Amazon Glacier （原始獨立保存庫型服務） 不再接受新客戶。Amazon Glacier 是一項獨立服務，具有自己的 APIs，可將資料存放在保存庫中，並與 Amazon S3 和 Amazon S3 Glacier 儲存類別不同。您現有的資料將在 Amazon Glacier 中無限期保持安全且可存取。不需要遷移。對於低成本、長期的封存儲存， AWS 建議使用 [Amazon S3 Glacier 儲存類別](https://aws.amazon.com/s3/storage-classes/glacier/)，透過 S3 儲存貯體型 APIs、完整 AWS 區域 可用性、降低成本 AWS 和服務整合，提供卓越的客戶體驗。如果您想要增強功能，請考慮使用我們的解決方案指南，將資料從 Amazon S3 Glacier 保存庫傳輸至 Amazon S3 Glacier 儲存類別，以遷移至 Amazon S3 Glacier 儲存類別。 [AWS Amazon Glacier Amazon S3 ](https://aws.amazon.com/solutions/guidance/data-transfer-from-amazon-s3-glacier-vaults-to-amazon-s3/)

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Amazon Glacier 的 API 參考
<a name="amazon-glacier-api"></a>

Amazon Glacier 支援一組操作，特別是一組 RESTful API 呼叫，可讓您與服務互動。

您可以使用任何可以傳送 HTTP 請求的程式設計程式庫，將您的 REST 請求傳送至 Amazon Glacier。傳送 REST 請求時，Amazon Glacier 會要求您透過簽署請求來驗證每個請求。此外，在上傳封存時，您還必須計算檢查總和的承載，並將其包含在您的請求。如需詳細資訊，請參閱[簽署請求](amazon-glacier-signing-requests.md)。

如果發生錯誤，您需要知道 Amazon Glacier 在錯誤回應中傳送什麼，以便處理它。除了記錄 REST 操作之外，本節還提供了所有這些資訊，以便您可以直接進行 REST API 呼叫。

您可以直接使用 REST API 呼叫，或者使用提供包裝函式庫的 Amazon 開發套件。這些程式庫對您傳送的每個請求進行簽署，並計算請求中承載的檢查總和。因此，使用 Amazon 開發套件可簡化編碼任務。此開發人員指南提供使用 適用於 Java 的 AWS SDK 和 .NET 的基本 Amazon Glacier 操作的工作範例。如需詳細資訊，請參閱 [搭配 Amazon Glacier 使用 AWS SDKs](using-aws-sdk.md)。

**Topics**
+ [常見請求標題](api-common-request-headers.md)
+ [常見回應標頭](api-common-response-headers.md)
+ [簽署請求](amazon-glacier-signing-requests.md)
+ [運算檢查總和](checksum-calculations.md)
+ [錯誤回應](api-error-responses.md)
+ [保存庫作業](vault-operations.md)
+ [封存操作](archive-operations.md)
+ [分段上傳操作](multipart-archive-operations.md)
+ [任務操作](job-operations.md)
+ [在任務操作中使用的資料類型](api-data-types.md)
+ [資料擷取操作](data-retrieval-policy-operations.md)

# 常見請求標題
<a name="api-common-request-headers"></a>

Amazon Glacier (Amazon Glacier) REST 請求包含包含請求基本資訊的標頭。下表說明所有 Amazon Glacier REST 請求可以使用的標頭。


| 標頭名稱 | 說明 | 必要 | 
| --- | --- | --- | 
| Authorization |  簽署請求所需的標頭。Amazon Glacier 需要 Signature 第 4 版。如需詳細資訊，請參閱[簽署請求](amazon-glacier-signing-requests.md)。 類型：字串  | 是 | 
| Content-Length |  請求本文的長度 (不含標頭)。 類型：字串 條件：僅適用於 [上傳封存 (POST 封存)](api-archive-post.md) API。  | 有條件 | 
| Date |  用來建立 `Authorization` 標頭中包含的簽章的日期。如果要使用 `Date` 標頭簽署時，必須指定要使用 ISO 8601 基本格式。在這種情況下，不需要 `x-amz-date` 標頭。請注意，當 `x-amz-date` 存在時，一律覆寫 `Date` 標頭的值。 如果日期標頭不會用來簽署， 則它可以是 [RFC 2616](http://tools.ietf.org/html/rfc2616#section-3.3) (3.3 節) 指定的完整日期格式之一。例如，下列日期/時間`Wed, 10 Feb 2017 12:00:00 GMT`是與 Amazon Glacier 搭配使用的有效日期/時間標頭。 如果您使用 `Date` 標頭進行簽署，則必須採用 ISO 8601 基本的 `YYYYMMDD'T'HHMMSS'Z'` 格式。 類型：字串 條件：如果已指定 `Date`，但不符合 ISO 8601 基本格式，則必須也包含 `x-amz-date` 標頭。如果 `Date` 是以 ISO 8601 基本格式指定的，那麼這對於簽署請求已足夠，並且您不需要 `x-amz-date` 標頭。如需詳細資訊，請參閱 [Amazon Web Services 詞彙表](https://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html)中的 *Signature 第 4 版中的處理日期*。  | 有條件  | 
| Host |  此標頭指定您傳送請求的服務終端節點。值的格式必須是 "`glacier.region.amazonaws.com`"，其中*區域*會取代為 AWS 區域名稱，例如 `us-west-2`。 類型：字串  | 是 | 
| x-amz-content-sha256 |  使用 [上傳封存 (POST 封存)](api-archive-post.md) 或 [分段上傳 (PUT uploadID)](api-upload-part.md) 上傳的整個承載的計算 SHA256 檢查總和。這個標頭與 `x-amz-sha256-tree-hash` 標頭不同，但是對於某些小型承載，這些值是相同的。當 `x-amz-content-sha256` 是必要的，必須指定 `x-amz-content-sha256` 和 `x-amz-sha256-tree-hash`。 類型：字串 條件：串流 API 的必要項目、[上傳封存 (POST 封存)](api-archive-post.md) 和 [分段上傳 (PUT uploadID)](api-upload-part.md)。  | 有條件 | 
| x-amz-date |  用來在授權標頭中建立簽章的日期。格式必須是 ISO 8601 基本的 `YYYYMMDD'T'HHMMSS'Z'` 格式。例如，下列日期/時間`20170210T120000Z``x-amz-date`適用於 Amazon Glacier。 類型：字串 條件：`x-amz-date` 對所有請求都是選用的，都可以用於覆寫用於簽署請求的日期。如果 `Date` 標頭是以 ISO 8601 基本格式指定的，則不需要 `x-amz-date`。當 `x-amz-date` 存在時，一律覆寫 `Date` 標頭的值。如需詳細資訊，請參閱 [Amazon Web Services 詞彙表](https://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html)中的 *Signature 第 4 版中的處理日期*。  | 有條件 | 
| x-amz-glacier-version |  要使用的 Amazon Glacier API 版本。目前版本是 `2012-06-01`。 類型：字串  | 是 | 
| x-amz-sha256-tree-hash |  上傳封存 ([上傳封存 (POST 封存)](api-archive-post.md)) 或封存部分 ([分段上傳 (PUT uploadID)](api-upload-part.md)) 的計算 SHA256 樹雜湊檢查總和。如需計算此檢查總和的詳細資訊，請參閱 [運算檢查總和](checksum-calculations.md)。 類型：字串 預設：無 條件：[上傳封存 (POST 封存)](api-archive-post.md) 和 [分段上傳 (PUT uploadID)](api-upload-part.md) 是必要的。  | 有條件 | 

# 常見回應標頭
<a name="api-common-response-headers"></a>

下表說明常用於大部分 API 回應的回應標頭。


|  名稱  |  描述  | 
| --- | --- | 
| Content-Length |  回應內文的長度，以位元組為單位。 類型：字串  | 
| Date |  Amazon Glacier (Amazon Glacier) 回應的日期和時間，例如 `Wed, 10 Feb 2017 12:00:00 GMT`。日期格式必須是 [RFC 2616](https://datatracker.ietf.org/doc/html/rfc2616#section-3.3) 第 3.3 節中規定的完整日期格式之一 。請注意，傳回的 `Date` 可能從其他日期稍微偏移，因此，從 [上傳封存 (POST 封存)](api-archive-post.md) 請求傳回的日期，可能不符合保存庫的庫存清單中為封存顯示的日期。 類型：字串  | 
| x-amzn-RequestId |  Amazon Glacier 建立的值，可唯一識別您的請求。如果 Amazon Glacier 發生問題， AWS 可以使用此值對問題進行故障診斷。建議您記錄這些值。 類型：字串  | 
| x-amz-sha256-tree-hash​ |  封存或庫存內文的 SHA256 樹雜湊檢查總和。如需計算此檢查總和的詳細資訊，請參閱 [運算檢查總和](checksum-calculations.md)。 類型：字串  | 

# 簽署請求
<a name="amazon-glacier-signing-requests"></a>

Amazon Glacier 要求您透過簽署請求來驗證您傳送的每個請求。若要簽署請求，請使用加密雜湊函數來計算數位簽章。加密雜湊是一個函數, 其根據輸入傳回一個唯一的雜湊值。此雜湊函數的輸入包含請求和私密存取金鑰的文字。雜湊函數會傳回一個雜湊值，您將此值包含在請求中做為簽章。該簽章是請求 `Authorization` 標頭中的一部分。

收到請求後，Amazon Glacier 會使用您用來簽署請求的相同雜湊函數和輸入來重新計算簽章。如果產生的簽章符合請求中的簽章，Amazon Glacier 會處理請求。否則，請求會遭到拒絕。

Amazon Glacier 支援使用 [AWS Signature 第 4 版](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)進行身分驗證。計算簽章的程序可以分成三個任務：

 
+   [任務 1：建立正式請求](https://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html)

  將 HTTP 請求重新編排為正式格式。使用正式表單是必要的，因為 Amazon Glacier 在重新計算簽章以與您傳送的簽章進行比較時，會使用相同的正式表單。
+   [任務 2：建立登入字串](https://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html)

  建立一個字串，您會使用此字串做為密碼編譯雜湊函數的其中一個輸入值。此字串，稱為*登入字串*，是雜湊演算法的名稱、請求日期、*登入資料範圍*字串和前一個任務的正式請求的串連。*登入資料範圍*字串本身是日期、 AWS 區域和服務資訊的串連。
+   [任務 3：建立簽章](https://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html)

  使用接受兩個輸入字串的密碼編譯雜湊函數來建立請求的簽章：您的 *登入字串*和*衍生金鑰*。藉由從您的私密存取金鑰開始來計算此*衍生金鑰*和使用*登入資料範圍* 字串來建立一系列雜湊型訊息身分驗證代碼 (HMAC)。請注意，此簽署步驟中使用的雜湊函數不是用於上傳資料的 Amazon Glacier APIs 的樹雜湊演算法。

**Topics**
+ [簽章計算範例](#example-signature-calculation)
+ [計算串流操作的簽章](#signature-calculation-streaming)

## 簽章計算範例
<a name="example-signature-calculation"></a>

以下範例會逐步解說為 [建立保存庫 (PUT 保存庫)](api-vault-put.md) 建立簽章的詳細資訊 。此範例可用作檢查簽名簽章計算方法的參考。如需詳細資訊，請參閱《*IAM 使用者指南*》中的[簽署 AWS API 請求](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)。

該範例假設如下：
+ 請求的時間戳記為 `Fri, 25 May 2012 00:24:53 GMT`。
+ 端點是美國東部 (維吉尼亞北部) 區域 (` us-east-1`)。

一般請求語法 (包括 JSON 內文) 是：

```
PUT /-/vaults/examplevault HTTP/1.1
Host: glacier.us-east-1.amazonaws.com
Date: Fri, 25 May 2012 00:24:53 GMT
Authorization: SignatureToBeCalculated
x-amz-glacier-version: 2012-06-01
```

對於[任務1：建立正式請求](#SignatureCalculationTask1)計算的請求的正式形式是：

 

```
PUT
/-/vaults/examplevault

host:glacier.us-east-1.amazonaws.com
x-amz-date:20120525T002453Z
x-amz-glacier-version:2012-06-01

host;x-amz-date;x-amz-glacier-version
e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
```

正式請求的最後一行是請求內文的雜湊值。另外，請注意正式請求中的空的第三行。這是因為此 API 沒有查詢參數。

要為*任務 2：建立要簽章的字串* [簽章的字串](#SignatureCalculationTask2)是：

 

```
AWS4-HMAC-SHA256
20120525T002453Z
20120525/us-east-1/glacier/aws4_request
5f1da1a2d0feb614dd03d71e87928b8e449ac87614479332aced3a701f916743
```

 

*登入字串*的第一行是演算法，第二行是時間戳記，第三行是*登入資料範圍*，最後一行是來自[任務 1：建立正式請求](#SignatureCalculationTask1)的正式請求的雜湊。在憑證範圍內使用的服務名稱是 `glacier`。

對於[任務 3：建立簽章](#SignatureCalculationTask3)，*衍生金鑰*可以呈現為：

 

```
derived key = HMAC(HMAC(HMAC(HMAC("AWS4" + YourSecretAccessKey,"20120525"),"us-east-1"),"glacier"),"aws4_request")
```

如果使用私密存取金鑰 `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`，則計算簽章是：

 

```
3ce5b2f2fffac9262b4da9256f8d086b4aaf42eba5f111c21681a65a127b7c2a
```

 

最後步驟是建立 `Authorization` 標頭。對於示範存取金鑰 `AKIAIOSFODNN7EXAMPLE`，標頭 (為了可讀性而新增了換行) 是：

 

```
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120525/us-east-1/glacier/aws4_request, 
SignedHeaders=host;x-amz-date;x-amz-glacier-version, 
Signature=3ce5b2f2fffac9262b4da9256f8d086b4aaf42eba5f111c21681a65a127b7c2a
```

 

## 計算串流操作的簽章
<a name="signature-calculation-streaming"></a>

[上傳封存 (POST 封存)](api-archive-post.md) 和 [分段上傳 (PUT uploadID)](api-upload-part.md) 是串流操作，需要您在簽章和發送請求時包含附加標頭 `x-amz-content-sha256`。串流操作的簽章步驟與其他操作的簽章步驟完全相同，但增加了串流標頭。

串流標頭 `x-amz-content-sha256` 的計算是依據要上傳的整個內容 (承載) 的 SHA256 雜湊。請注意，這個計算不同於 SHA256 樹狀雜湊 ([運算檢查總和](checksum-calculations.md))。除了微不足道的情況外，承載資料的 SHA 256 雜湊值將與承載資料的 SHA256 樹狀雜湊不同。

如果承載資料指定為位元組陣列，則可以使用以下 Java 程式碼片段來運算 SHA256 雜湊。

 

```
public static byte[] computePayloadSHA256Hash2(byte[] payload) throws NoSuchAlgorithmException, IOException {
    BufferedInputStream bis = 
       new BufferedInputStream(new ByteArrayInputStream(payload));
    MessageDigest messageDigest = MessageDigest.getInstance("SHA-256");
    byte[] buffer = new byte[4096];
    int bytesRead = -1;
    while ( (bytesRead = bis.read(buffer, 0, buffer.length)) != -1 ) {
        messageDigest.update(buffer, 0, bytesRead);
    }
    return messageDigest.digest();
}
```

同樣地，在 C\$1 ，您可以計算承載資料的 SHA256 雜湊，如以下的程式碼片段所示。

 

```
public static byte[] CalculateSHA256Hash(byte[] payload)
{
    SHA256 sha256 = System.Security.Cryptography.SHA256.Create();
    byte[] hash = sha256.ComputeHash(payload);

    return hash;
}
```

### 串流 API 的簽章計算範例
<a name="example-signature-calculation-streaming"></a>

下列範例會逐步解說為 建立簽章的詳細資訊[上傳封存 (POST 封存)](api-archive-post.md)，這是 Amazon Glacier 中兩個串流 APIs 的其中之一。該範例假設如下：
+ 請求的時間戳記為 `Mon, 07 May 2012 00:00:00 GMT`。
+ 端點是美國東部 (維吉尼亞北部) 區域 (us-east-1)。
+ 內容承載是字串「歡迎使用 Amazon Glacier」。

下面的範例顯示一般請求語法 (包括 JSON 內文)。請注意，包含 ` x-amz-content-sha256` 標頭。在這個簡化的範例中，`x-amz-sha256-tree-hash` 和 `x-amz-content-sha256` 是相同的值。但是，對於大於 1 MB 的封存上傳，情況並非如此。

```
POST /-/vaults/examplevault HTTP/1.1
Host: glacier.us-east-1.amazonaws.com
Date: Mon, 07 May 2012 00:00:00 GMT
x-amz-archive-description: my archive
x-amz-sha256-tree-hash: SHA256 tree hash
x-amz-content-sha256: SHA256 payload hash  
Authorization: SignatureToBeCalculated
x-amz-glacier-version: 2012-06-01
```

對於[任務 1：建立正式請求](#SignatureCalculationTask1) 計算的請求的正式形式如下所示。請注意，串流標頭 `x-amz-content-sha256` 包含其值。這表示您必須先讀取承載和計算 SHA256 雜湊，然後再計算簽章。

 

```
POST
/-/vaults/examplevault

host:glacier.us-east-1.amazonaws.com
x-amz-content-sha256:726e392cb4d09924dbad1cc0ba3b00c3643d03d14cb4b823e2f041cff612a628
x-amz-date:20120507T000000Z
x-amz-glacier-version:2012-06-01

host;x-amz-content-sha256;x-amz-date;x-amz-glacier-version
726e392cb4d09924dbad1cc0ba3b00c3643d03d14cb4b823e2f041cff612a628
```

剩餘的簽章計算遵循 [簽章計算範例](#example-signature-calculation) 中概述的步驟。使用私密存取金鑰`Authorization` 和存取金鑰 `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY` 的 `AKIAIOSFODNN7EXAMPLE` 標頭如下所示 (為了可讀性而增加了換行)：

 

```
Authorization=AWS4-HMAC-SHA256 
Credential=AKIAIOSFODNN7EXAMPLE/20120507/us-east-1/glacier/aws4_request, 
SignedHeaders=host;x-amz-content-sha256;x-amz-date;x-amz-glacier-version, 
Signature=b092397439375d59119072764a1e9a144677c43d9906fd98a5742c57a2855de6
```

 

# 運算檢查總和
<a name="checksum-calculations"></a>

當上傳封存時，您必須同時包含 `x-amz-sha256-tree-hash` 和 `x-amz-content-sha256` 標頭。`x-amz-sha256-tree-hash` 標題是您的請求內文中承載的檢查總和。此主題說明如何計算 `x-amz-sha256-tree-hash` 標頭。`x-amz-content-sha256` 標頭是整個承載的雜湊，並且是授權所需。如需詳細資訊，請參閱[串流 API 的簽章計算範例](amazon-glacier-signing-requests.md#example-signature-calculation-streaming)。

請求的承載內容可以是：

 
+ **整個封存：**在單一請求中使用上傳封存 API 上傳封存時，您在請求內文傳送整個封存。在這種情況下，您必須包含整個封存的檢查總和。
+ **封存部分：**使用分段上傳 API 以部分形式上傳封存時，您僅在請求內文傳送部分封存。在這種情況下，會包含封存部分的檢查總和。而且在上傳所有的部分後，您會完成分段上傳請求，其必須包含整個封存的檢查總和。

承載的檢查總和是 SHA-256 樹雜湊。其稱為樹雜湊的原因是，在運算檢查總和的過程中，您會計算 SHA-256 樹雜湊值。根的雜湊值是整個封存的檢查總和。

 

**注意**  
本節說明運算 SHA-256 樹雜湊的方式。不過，您可以使用任何會產生相同結果的程序。

您運算 SHA-256 樹雜湊，如下所示：

 

1. 對於每個 1 MB 區塊的承載資料，運算 SHA-256 雜湊。最後區塊的資料可能小於 1 MB。例如，如果上傳 3.2 MB 的封存，您為前三個 1 MB 的資料區塊的每一個運算 SHA-256 雜湊值，然後運算剩餘 0.2 MB 資料的 SHA-256 雜湊。這些雜湊值形成樹狀結構的分葉節點。

1. 建置下一個層級的樹狀結構。

   1. 串連兩個連續的子節點雜湊值，並且運算已串連雜湊值的 SHA-256 雜湊。這個串連及 SHA-256 雜湊的產生會產生兩個子節點的父節點。

   1. 如果只剩一個子節點，就會將該雜湊值提升到樹狀結構的下一個層級。

1. 重複步驟 2，直到產生的樹狀結構有根。樹狀結構的根提供整個封存的雜湊，而適當子樹狀結構則提供分段上傳部分的雜湊。

**Topics**
+ [樹雜湊範例 1：在單一請求上傳封存](#checksum-calculations-upload-archive-in-single-payload)
+ [樹雜湊範例 2：使用分段上傳來上傳封存](#checksum-calculations-upload-archive-using-mpu)
+ [運算檔案的樹雜湊](#checksum-calculations-examples)
+ [下載資料時接收檢查總和](checksum-calculations-range.md)

## 樹雜湊範例 1：在單一請求上傳封存
<a name="checksum-calculations-upload-archive-in-single-payload"></a>

在單一請求中使用上傳封存 API 上傳封存時 (請參閱 [上傳封存 (POST 封存)](api-archive-post.md)) 請求承載包含整個封存。因此，您必須在 `x-amz-sha256-tree-hash` 請求標頭中包含整個封存的樹雜湊。假設您想要上傳 6.5 MB 的封存。下圖說明建立封存的 SHA-256 雜湊的程序。您讀取封存並運算每 1 MB 區塊的 SHA-256 雜湊。您也運算剩餘 0.5 MB 資料的雜湊，然後依所述的樹狀結構建置程序。

 

![\[圖表顯示在單一請求中上傳封存的樹雜湊範例。\]](http://docs.aws.amazon.com/zh_tw/amazonglacier/latest/dev/images/TreeHash-ArchiveUploadSingleRequest.png)


## 樹雜湊範例 2：使用分段上傳來上傳封存
<a name="checksum-calculations-upload-archive-using-mpu"></a>

在使用分段上傳來上傳封存時，其運算樹雜湊的程序和在單一請求上傳封存的程序是相同的。唯一的差別是，在分段上傳只上傳每個請求的一部分封存 (使用 [分段上傳 (PUT uploadID)](api-upload-part.md) API)，因此，您只提供 `x-amz-sha256-tree-hash` 請求標頭部分的檢查總和。不過，在上傳所有部分後，您必須隨著 [完成分段上傳 (POST uploadID)](api-multipart-complete-upload.md) 請求標頭中整個封存的樹雜湊，傳送「完成分段上傳」(請參閱 `x-amz-sha256-tree-hash`) 請求。

 

![\[顯示使用分段上傳上傳封存之樹雜湊範例的圖表。\]](http://docs.aws.amazon.com/zh_tw/amazonglacier/latest/dev/images/TreeHash-MPU.png)


## 運算檔案的樹雜湊
<a name="checksum-calculations-examples"></a>

這裡所顯示的演算法僅示範之目定而選定。您可以視您實作情況的需要最佳化程式碼。如果您使用 Amazon SDK 針對 Amazon Glacier (Amazon Glacier) 進行程式設計，則會為您完成樹雜湊計算，而且您只需要提供檔案參考。

**Example 1: Java 範例**  
以下範例說明如何計算使用 Java 的檔案的 SHA256 樹雜湊。您可以執行這個範例，做法是提供檔案位置做為引數，或可直接從您的程式碼使用 `TreeHashExample.computeSHA256TreeHash` 方法。  

```
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

public class TreeHashExample {

static final int ONE_MB = 1024 * 1024;

    /**
     * Compute the Hex representation of the SHA-256 tree hash for the specified
     * File
     * 
     * @param args
     *            args[0]: a file to compute a SHA-256 tree hash for
     */
    public static void main(String[] args) {

        if (args.length < 1) {
            System.err.println("Missing required filename argument");
            System.exit(-1);
        }

        File inputFile = new File(args[0]);
        try {

            byte[] treeHash = computeSHA256TreeHash(inputFile);
            System.out.printf("SHA-256 Tree Hash = %s\n", toHex(treeHash));

        } catch (IOException ioe) {
            System.err.format("Exception when reading from file %s: %s", inputFile,
                    ioe.getMessage());
            System.exit(-1);

        } catch (NoSuchAlgorithmException nsae) {
            System.err.format("Cannot locate MessageDigest algorithm for SHA-256: %s",
                    nsae.getMessage());
            System.exit(-1);
        }
    }

    /**
     * Computes the SHA-256 tree hash for the given file
     * 
     * @param inputFile
     *            a File to compute the SHA-256 tree hash for
     * @return a byte[] containing the SHA-256 tree hash
     * @throws IOException
     *             Thrown if there's an issue reading the input file
     * @throws NoSuchAlgorithmException
     */
    public static byte[] computeSHA256TreeHash(File inputFile) throws IOException,
            NoSuchAlgorithmException {

        byte[][] chunkSHA256Hashes = getChunkSHA256Hashes(inputFile);
        return computeSHA256TreeHash(chunkSHA256Hashes);
    }

    /**
     * Computes a SHA256 checksum for each 1 MB chunk of the input file. This
     * includes the checksum for the last chunk even if it is smaller than 1 MB.
     * 
     * @param file
     *            A file to compute checksums on
     * @return a byte[][] containing the checksums of each 1 MB chunk
     * @throws IOException
     *             Thrown if there's an IOException when reading the file
     * @throws NoSuchAlgorithmException
     *             Thrown if SHA-256 MessageDigest can't be found
     */
    public static byte[][] getChunkSHA256Hashes(File file) throws IOException,
            NoSuchAlgorithmException {

        MessageDigest md = MessageDigest.getInstance("SHA-256");

        long numChunks = file.length() / ONE_MB;
        if (file.length() % ONE_MB > 0) {
            numChunks++;
        }

        if (numChunks == 0) {
            return new byte[][] { md.digest() };
        }

        byte[][] chunkSHA256Hashes = new byte[(int) numChunks][];
        FileInputStream fileStream = null;

        try {
            fileStream = new FileInputStream(file);
            byte[] buff = new byte[ONE_MB];

            int bytesRead;
            int idx = 0;
            int offset = 0;

            while ((bytesRead = fileStream.read(buff, offset, ONE_MB)) > 0) {
                md.reset();
                md.update(buff, 0, bytesRead);
                chunkSHA256Hashes[idx++] = md.digest();
                offset += bytesRead;
            }

            return chunkSHA256Hashes;

        } finally {
            if (fileStream != null) {
                try {
                    fileStream.close();
                } catch (IOException ioe) {
                    System.err.printf("Exception while closing %s.\n %s", file.getName(),
                            ioe.getMessage());
                }
            }
        }
    }

    /**
     * Computes the SHA-256 tree hash for the passed array of 1 MB chunk
     * checksums.
     * 
     * This method uses a pair of arrays to iteratively compute the tree hash
     * level by level. Each iteration takes two adjacent elements from the
     * previous level source array, computes the SHA-256 hash on their
     * concatenated value and places the result in the next level's destination
     * array. At the end of an iteration, the destination array becomes the
     * source array for the next level.
     * 
     * @param chunkSHA256Hashes
     *            An array of SHA-256 checksums
     * @return A byte[] containing the SHA-256 tree hash for the input chunks
     * @throws NoSuchAlgorithmException
     *             Thrown if SHA-256 MessageDigest can't be found
     */
    public static byte[] computeSHA256TreeHash(byte[][] chunkSHA256Hashes)
            throws NoSuchAlgorithmException {

        MessageDigest md = MessageDigest.getInstance("SHA-256");

        byte[][] prevLvlHashes = chunkSHA256Hashes;

        while (prevLvlHashes.length > 1) {

            int len = prevLvlHashes.length / 2;
            if (prevLvlHashes.length % 2 != 0) {
                len++;
            }

            byte[][] currLvlHashes = new byte[len][];

            int j = 0;
            for (int i = 0; i < prevLvlHashes.length; i = i + 2, j++) {

                // If there are at least two elements remaining
                if (prevLvlHashes.length - i > 1) {

                    // Calculate a digest of the concatenated nodes
                    md.reset();
                    md.update(prevLvlHashes[i]);
                    md.update(prevLvlHashes[i + 1]);
                    currLvlHashes[j] = md.digest();

                } else { // Take care of remaining odd chunk
                    currLvlHashes[j] = prevLvlHashes[i];
                }
            }

            prevLvlHashes = currLvlHashes;
        }

        return prevLvlHashes[0];
    }

    /**
     * Returns the hexadecimal representation of the input byte array
     * 
     * @param data
     *            a byte[] to convert to Hex characters
     * @return A String containing Hex characters
     */
    public static String toHex(byte[] data) {
        StringBuilder sb = new StringBuilder(data.length * 2);

        for (int i = 0; i < data.length; i++) {
            String hex = Integer.toHexString(data[i] & 0xFF);

            if (hex.length() == 1) {
                // Append leading zero.
                sb.append("0");
            }
            sb.append(hex);
        }
        return sb.toString().toLowerCase();
    }
}
```

**Example 2: C\$1 .NET 範例**  
以下範例說明如何計算使檔案的 SHA256 樹雜湊。您可以執行此範例，做法是提供檔案位置做為引數。  

```
using System;
using System.IO;

using System.Security.Cryptography;

namespace ExampleTreeHash
{
    class Program
    {
        static int ONE_MB = 1024 * 1024;

        /**
        * Compute the Hex representation of the SHA-256 tree hash for the
        * specified file
        * 
        * @param args
        *            args[0]: a file to compute a SHA-256 tree hash for
        */
        public static void Main(string[] args)
        {
            if (args.Length < 1)
            {
                Console.WriteLine("Missing required filename argument");
                Environment.Exit(-1);
            }
            FileStream inputFile = File.Open(args[0], FileMode.Open, FileAccess.Read);
            try
            {
                byte[] treeHash = ComputeSHA256TreeHash(inputFile);
                Console.WriteLine("SHA-256 Tree Hash = {0}", BitConverter.ToString(treeHash).Replace("-", "").ToLower());
                Console.ReadLine();
                Environment.Exit(-1);
            }
            catch (IOException ioe)
            {
                Console.WriteLine("Exception when reading from file {0}: {1}",
                    inputFile, ioe.Message);
                Console.ReadLine();
                Environment.Exit(-1);
            }
            catch (Exception e)
            {
                Console.WriteLine("Cannot locate MessageDigest algorithm for SHA-256: {0}",
                    e.Message);
                Console.WriteLine(e.GetType());
                Console.ReadLine();
                Environment.Exit(-1);
            }
            Console.ReadLine();
        }


        /**
         * Computes the SHA-256 tree hash for the given file
         * 
         * @param inputFile
         *            A file to compute the SHA-256 tree hash for
         * @return a byte[] containing the SHA-256 tree hash
         */
        public static byte[] ComputeSHA256TreeHash(FileStream inputFile)
        {
            byte[][] chunkSHA256Hashes = GetChunkSHA256Hashes(inputFile);
            return ComputeSHA256TreeHash(chunkSHA256Hashes);
        }


        /**
         * Computes a SHA256 checksum for each 1 MB chunk of the input file. This
         * includes the checksum for the last chunk even if it is smaller than 1 MB.
         * 
         * @param file
         *            A file to compute checksums on
         * @return a byte[][] containing the checksums of each 1MB chunk
         */
        public static byte[][] GetChunkSHA256Hashes(FileStream file)
        {
            long numChunks = file.Length / ONE_MB;
            if (file.Length % ONE_MB > 0)
            {
                numChunks++;
            }

            if (numChunks == 0)
            {
                return new byte[][] { CalculateSHA256Hash(null, 0) };
            }
            byte[][] chunkSHA256Hashes = new byte[(int)numChunks][];

            try
            {
                byte[] buff = new byte[ONE_MB];

                int bytesRead;
                int idx = 0;

                while ((bytesRead = file.Read(buff, 0, ONE_MB)) > 0)
                {
                    chunkSHA256Hashes[idx++] = CalculateSHA256Hash(buff, bytesRead);
                }
                return chunkSHA256Hashes;
            }
            finally
            {
                if (file != null)
                {
                    try
                    {
                        file.Close();
                    }
                    catch (IOException ioe)
                    {
                        throw ioe;
                    }
                }
            }

        }

        /**
         * Computes the SHA-256 tree hash for the passed array of 1MB chunk
         * checksums.
         * 
         * This method uses a pair of arrays to iteratively compute the tree hash
         * level by level. Each iteration takes two adjacent elements from the
         * previous level source array, computes the SHA-256 hash on their
         * concatenated value and places the result in the next level's destination
         * array. At the end of an iteration, the destination array becomes the
         * source array for the next level.
         * 
         * @param chunkSHA256Hashes
         *            An array of SHA-256 checksums
         * @return A byte[] containing the SHA-256 tree hash for the input chunks
         */
        public static byte[] ComputeSHA256TreeHash(byte[][] chunkSHA256Hashes)
        {
            byte[][] prevLvlHashes = chunkSHA256Hashes;
            while (prevLvlHashes.GetLength(0) > 1)
            {

                int len = prevLvlHashes.GetLength(0) / 2;
                if (prevLvlHashes.GetLength(0) % 2 != 0)
                {
                    len++;
                }

                byte[][] currLvlHashes = new byte[len][];

                int j = 0;
                for (int i = 0; i < prevLvlHashes.GetLength(0); i = i + 2, j++)
                {

                    // If there are at least two elements remaining
                    if (prevLvlHashes.GetLength(0) - i > 1)
                    {

                        // Calculate a digest of the concatenated nodes
                        byte[] firstPart = prevLvlHashes[i];
                        byte[] secondPart = prevLvlHashes[i + 1];
                        byte[] concatenation = new byte[firstPart.Length + secondPart.Length];
                        System.Buffer.BlockCopy(firstPart, 0, concatenation, 0, firstPart.Length);
                        System.Buffer.BlockCopy(secondPart, 0, concatenation, firstPart.Length, secondPart.Length);

                        currLvlHashes[j] = CalculateSHA256Hash(concatenation, concatenation.Length);

                    }
                    else
                    { // Take care of remaining odd chunk
                        currLvlHashes[j] = prevLvlHashes[i];
                    }
                }

                prevLvlHashes = currLvlHashes;
            }

            return prevLvlHashes[0];
        }

        public static byte[] CalculateSHA256Hash(byte[] inputBytes, int count)
        {
            SHA256 sha256 = System.Security.Cryptography.SHA256.Create();
            byte[] hash = sha256.ComputeHash(inputBytes, 0, count);
            return hash;
        }
    }
}
```

# 下載資料時接收檢查總和
<a name="checksum-calculations-range"></a>

當您使用啟動任務 API 擷取封存時 (請參閱 [啟動任務 (POST 任務)](api-initiate-job-post.md))，您可以選擇性指定擷取封存的範圍。同樣地，當您使用取得任務輸出 API 下載資料時 (請參閱 [「取得任務輸出」 (GET 輸出)](api-job-output-get.md))，您可以選擇指定各種下載資料。當您在擷取和下載封存的資料時，務必要了解這些範圍的兩個特性。擷取範圍對封存而言需要*符合 MB*。擷取範圍和下載範圍都必須*符合樹雜湊*，才能在您下載資料時接收檢查總和值。這兩種類型的範圍合規遵循的定義如下：

 
+ 符合 MB：當 *StartBytes* 可以被 1 MB 整除，而 *EndBytes* 加 1 可以被 1 MB 整除，或等於指定的封存結尾時 (封存位元組大小減 1)，範圍 [*StartByte*, *EndBytes*] 是符合 MB (1024\$1 1024)。如果有指定，啟動任務 API 中使用的範圍需要符合 MB。
+ 符合樹雜湊 - 範圍 [* StartBytes *、* EndBytes *] 是與封存相關的符合樹雜湊，如果且只有在樹雜湊根目錄的建置範圍等同於整個封存的樹雜湊節點。擷取範圍和下載範圍都必須符合樹雜湊，才能接收您下載資料的檢查總和值。如需範圍範例及其與封存樹雜湊之關係的詳細資訊，請參閱 [樹雜湊範例：擷取符合樹雜湊的封存範圍](#checksum-calculations-upload-archive-with-ranges)。

  請注意，符合樹雜湊之範圍，也符合 MB。然而，符合 MB 範圍並不一定需符合樹雜湊。

以下案例描述您何時在下載封存資料接收檢查總和值：

 
+ 如果您未在啟動任務請求中指定擷取的範圍，而且在取得任務請求中下載整個封存。
+ 如果您未在啟動任務請求中指定擷取的範圍，卻在取得任務請求中指定符合樹雜湊的範圍。
+ 如果您在啟動任務請求中指定符合樹雜湊的範圍，而且在取得任務請求中下載整個範圍。
+ 如果您在啟動任務請求中指定符合樹雜湊的範圍，並且在取得任務請求中指定符合樹雜湊的範圍。

如果您在啟動任務請求中指定非符合樹雜湊的擷取範圍，您仍然可以取得封存資料，但在取得任務請求中下載資料時並未有任何檢查總和值傳回。

## 樹雜湊範例：擷取符合樹雜湊的封存範圍
<a name="checksum-calculations-upload-archive-with-ranges"></a>

假設您的保存庫中有 6.5 MB 的封存，而您想要擷取 2 MB 的封存。您如何在啟動任務請求中指定 2 MB 範圍，決定您是否會在下載資料時接收資料檢查總和值。下圖說明您可以下載的兩個用於 6.5 MB 封存的 2 MB 範圍。兩個範圍都是符合 MB，但只有一個符合樹雜湊。

 

![\[顯示擷取符合樹雜湊之封存範圍的圖表。\]](http://docs.aws.amazon.com/zh_tw/amazonglacier/latest/dev/images/TreeHash-ArchiveWithRanges.png)


## 符合樹雜湊範圍規格
<a name="tree-hash-algorithm"></a>

本節提供構成符合樹雜湊範圍的確切規格。下載封存的一部分，以及當指定擷取資料的範圍，並從擷取之資料下載的範圍時，符合樹雜湊範圍至關重要。如果這兩種範圍都符合樹雜湊，您將在下載資料時接收檢查總和資料。

範圍 [*A*、*B*] 是與封存相關的*符合樹雜湊*，如果且只有在新的樹雜湊建置在 [*A*、*B*] 上，且該範圍的樹雜湊根目錄等同於整個封存的樹雜湊節點。您可以查看相關內容，如 [樹雜湊範例：擷取符合樹雜湊的封存範圍](#checksum-calculations-upload-archive-with-ranges) 圖中所示。在本節中，我們提供了適用於符合樹雜湊的規格。

考量 [*P*、*Q*] 為 *N* 百萬位元組 (MB) 的封存範圍查詢，而 *P* 和 *Q* 則是一 MB 的倍數。請注意，實際包含範圍是 [*P* MB、*Q* MB – 1 個位元組]，但為簡單化，我們會將它顯示為 [*P*、*Q*]。在這些考量下，然後

 
+ 如果 *P* 是奇數，僅有一個可能的符合樹雜湊範圍 - 就是[*P*、*P* \$1 1 MB]。
+ 如果 *P* 是偶數，而 *k* 是最大數，其中 *P* 可以編寫為 2*k* \$1 *X*，則最多有 *k* 個符合樹雜湊範圍以 *P* 開頭。*X* 是大於 0 的整數。符合樹雜湊的範圍落在下列類別：
  + 對於每個 *i*，其中 (0 <= *i* <= *k*) 而且 *P* \$1 2*i* < *N*，然後 [*P*、*Q* \$1 2*i*] 是符合樹雜湊的範圍。
  + *P * = 0 是特殊情況，其中 *A* = 2[lgN]\$10

# 錯誤回應
<a name="api-error-responses"></a>

如果發生錯誤，此 API 會傳回以下其中一個例外狀況：


| Code | Description | HTTP 狀態碼 | Type | 
| --- | --- | --- | --- | 
| AccessDeniedException | 如果嘗試存取 AWS Identity and Access Management (IAM) 政策不允許的資源，或在請求 URI 中使用不正確的 AWS 帳戶 ID，則傳回。如需詳細資訊，請參閱[Amazon Glacier 的 Identity and Access Management](security-iam.md)。 | 403 Forbidden | 用戶端 | 
| BadRequest | 如果請求無法處理，則傳回。 | 400 Bad Request | 用戶端 | 
| ExpiredTokenException | 如果請求中使用的安全權杖已過期，則傳回。 | 403 Forbidden | 用戶端 | 
| InsufficientCapacityException | 如果沒有足夠的能力處理急件請求，則傳回。此錯誤僅適用於急件擷取，而不適用於標準或大量擷取。 | 503 Service Unavailable | Server | 
| InvalidParameterValueException | 如果未正確指定請求的參數，則傳回。 | 400 Bad Request | 用戶端 | 
| InvalidSignatureException | 如果請求簽章無效，則傳回。 | 403 Forbidden | 用戶端 | 
| LimitExceededException | 如果請求導致超出以下其中一個限額：保存庫限制、標籤限制或佈建的容量限制，則傳回。 | 400 Bad Request | 用戶端 | 
| MissingAuthenticationTokenException | 如果沒有該請求的驗證資料，則傳回。 | 400 Bad Request | 用戶端 | 
| MissingParameterValueException | 如果請求中缺少必要的標題或參數，則傳回。 | 400 Bad Request | 用戶端 | 
| PolicyEnforcedException | 如果擷取作業超過目前資料政策的擷取速率限制，則傳回。如需有關資料擷取政策的詳細資訊，請參閱 [Amazon Glacier 資料擷取政策](data-retrieval-policy.md)。 | 400 Bad Request | 用戶端 | 
| ResourceNotFoundException | 如果指定的資源不存在，例如保存庫、上傳 ID 或工作 ID，則傳回。 | 404 Not Found | 用戶端 | 
| RequestTimeoutException | 如果上傳封存，且 Amazon Glacier (Amazon Glacier) 在收到上傳時逾時，則傳回。 | 408 Request Timeout | 用戶端 | 
| SerializationException | 如果請求內文無效，則傳回。如果包括 JSON 承載，請檢查格式完好。 | 400 Bad Request | 用戶端 | 
| ServiceUnavailableException | 如果服務無法完成請求，則傳回。 | 500 Internal Server Error | Server | 
| ThrottlingException | 如果您需要降低對 Amazon Glacier 的請求率，則傳回。 | 400 Bad Request | 用戶端 | 
| UnrecognizedClientException | 如果存取金鑰 ID 或安全權杖無效，則傳回。 | 400 Bad Request | 用戶端 | 

各種 Amazon Glacier APIs都會傳回相同的例外狀況，但會有不同的例外狀況訊息，協助您疑難排解遇到的特定錯誤。

Amazon Glacier 傳回回應內文中的錯誤資訊。以下範例顯示一些錯誤回應。

## 範例 1：描述不存在的任務 ID 的任務請求
<a name="bad-request-error-example1"></a>

假設您傳送不存在任務的 [描述任務 (GET JobID)](api-describe-job-get.md) 請求。也就是說，您指定了不存在的任務 ID。

```
1. GET /-/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVEXAMPLEbadJobID HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

為了回應，Amazon Glacier 會傳回下列錯誤回應。

```
HTTP/1.1 404 Not Found
x-amzn-RequestId: AAABaZ9N92Iiyv4N7sru3ABEpSQkuFtmH3NP6aAC51ixfjg
Content-Type: application/json
Content-Length: 185
Date: Wed, 10 Feb 2017 12:00:00 GMT
{
  "code": "ResourceNotFoundException",
  "message": "The job ID was not found: HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVEXAMPLEbadJobID",
  "type": "Client"
  }
```

其中：

**Code**  
其中一個一般例外狀況。  
*類型：*字串

**Message**  
特定於傳回錯誤的 API 的錯誤狀況的一般描述。  
*類型：*字串

**類型**  
錯誤來源。該欄位可以是以下其中一個值：`Client`、`Server` 或 `Unknown`。  
*類型*：字串

在先前的回應中，請注意下列事項：
+ 對於錯誤回應，Amazon Glacier 會傳回 `4xx`和 的狀態碼值`5xx`。在此範例中，該狀態碼為 `404 Not Found`。
+ 此 `Content-Type` 標頭值 `application/json` 表示內文中的 JSON
+ 在內文的 JSON 提供錯誤資訊。

在之前的請求，假設您指定不存在的保存庫，而不是錯誤的工作 ID。該回應傳回不同的訊息。

```
HTTP/1.1 404 Not Found
x-amzn-RequestId: AAABBeC9Zw0rp_5D0L8VfB3FA_WlTupqTKAUehMcPhdgni0
Content-Type: application/json
Content-Length: 154
Date: Wed, 10 Feb 2017 12:00:00 GMT
{
  "code": "ResourceNotFoundException",
  "message": "Vault not found for ARN: arn:aws:glacier:us-west-2:012345678901:vaults/examplevault",
  "type": "Client"
}
```

## 範例 2：列出請求參數具有無效值的任務請求
<a name="bad-request-error-example2"></a>

在這個範例中，您傳送 [列出工作 (GET 工作)](api-jobs-get.md) 請求以擷取具有特定 `statuscode` 的保存庫工作，而且您提供錯誤的 `statuscode` 值 `finished`，而不是可接受的值 `InProgress`、`Succeeded` 或 `Failed`。

```
GET /-/vaults/examplevault/jobs?statuscode=finished HTTP/1.1 
Host: glacier.us-west-2.amazonaws.com 
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
```

Amazon Glacier 會傳回`InvalidParameterValueException`具有適當訊息的 。

```
HTTP/1.1 400 Bad Request
x-amzn-RequestId: AAABaZ9N92Iiyv4N7sru3ABEpSQkuFtmH3NP6aAC51ixfjg
Content-Type: application/json
Content-Length: 141
Date: Wed, 10 Feb 2017 12:00:00 GMT
{
  "code": "InvalidParameterValueException",
  "message": "The job status code is not valid: finished",
  "type: "Client"
}
```

# 保存庫作業
<a name="vault-operations"></a>

以下是 Amazon Glacier 中可用的保存庫操作。

**Topics**
+ [「中止保存庫鎖定」(DELETE 鎖定政策)](api-AbortVaultLock.md)
+ [新增標籤至保存庫 (POST 標籤新增)](api-AddTagsToVault.md)
+ [建立保存庫 (PUT 保存庫)](api-vault-put.md)
+ [完成保存庫鎖定 (POST lockId)](api-CompleteVaultLock.md)
+ [刪除文件庫 (DELETE 文件庫)](api-vault-delete.md)
+ [刪除保存庫存取政策 (DELETE 存取政策)](api-DeleteVaultAccessPolicy.md)
+ [刪除保存庫通知 (DELETE 通知的組態)](api-vault-notifications-delete.md)
+ [描述保存庫 (GET 保存庫)](api-vault-get.md)
+ [取得文件庫存取政策 (GET 存取政策)](api-GetVaultAccessPolicy.md)
+ [取得保存庫鎖定 (GET 鎖定政策)](api-GetVaultLock.md)
+ [取得文件庫通知 (GET 通知的組態)](api-vault-notifications-get.md)
+ [啟動保存庫鎖定 (POST 鎖定政策)](api-InitiateVaultLock.md)
+ [列出文件庫的標籤 (GET 標籤)](api-ListTagsForVault.md)
+ [「列出保存庫」(GET 保存庫)](api-vaults-get.md)
+ [從保存庫移除標籤 (POST tags remove)](api-RemoveTagsFromVault.md)
+ [設定保存庫存取政策 (PUT 存取政策)](api-SetVaultAccessPolicy.md)
+ [設定保存庫通知組態 (PUT 通知的組態)](api-vault-notifications-put.md)

# 「中止保存庫鎖定」(DELETE 鎖定政策)
<a name="api-AbortVaultLock"></a>

## 說明
<a name="api-AbortVaultLock-description"></a>

如果保存庫鎖定不是 `Locked` 狀態，此作業會停止保存庫鎖定程序。如果在請求此作業時，保存庫鎖定處於 `Locked` 狀態，則該作業將傳回 `AccessDeniedException` 錯誤。停止保存庫鎖定程序，會將保存庫鎖定政策從指定的保存庫中移除。

透過呼叫 `InProgress`，保存庫鎖定進入 [啟動保存庫鎖定 (POST 鎖定政策)](api-InitiateVaultLock.md) 狀態。透過呼叫 `Locked`，保存庫鎖定進入 [完成保存庫鎖定 (POST lockId)](api-CompleteVaultLock.md) 狀態。您可以透過呼叫 [取得保存庫鎖定 (GET 鎖定政策)](api-GetVaultLock.md) 來取得保存庫鎖定的狀態。如需保存庫鎖定程序的詳細資訊，請參閱[Amazon Glacier 保存庫鎖定](vault-lock.md)。如需保存庫鎖定政策的詳細資訊，請參閱[保存庫鎖定政策](vault-lock-policy.md)。

此為等冪操作。如果保存庫鎖定處於 `InProgress` 狀態或者沒有與保存庫關聯的政策，則可以多次成功呼叫此作業。

## 請求
<a name="api-AbortVaultLock-requests"></a>

若要刪除保存庫鎖定政策，請將 HTTP `DELETE` 請求傳送到保存庫 `lock-policy` 子資源的 URI。

### 語法
<a name="api-AbortVaultLock-requests-syntax"></a>

```
1. DELETE /AccountId/vaults/vaultName/lock-policy HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID 相符。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-AbortVaultLock-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-AbortVaultLock-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-AbortVaultLock-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-AbortVaultLock-responses"></a>

如果成功刪除政策，Amazon Glacier 會傳回`HTTP 204 No Content`回應。

### 語法
<a name="api-AbortVaultLock-responses-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-AbortVaultLock-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-AbortVaultLock-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-AbortVaultLock-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-AbortVaultLock-examples"></a>

以下範例示範如何停止保存庫鎖定程序。

### 範例請求
<a name="api-AbortVaultLock-example-request"></a>

在這個範例中，將 `DELETE` 請求傳送到名為 **examplevault** 的保存庫的 `lock-policy` 子資源。

```
1. DELETE /-/vaults/examplevault/lock-policy HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
5. x-amz-glacier-version: 2012-06-01
```

### 回應範例
<a name="api-AbortVaultLock-example-response"></a>

如果政策已成功刪除，Amazon Glacier 會傳回`HTTP 204 No Content`回應，如下列範例所示。

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
```

## 相關章節
<a name="related-sections-AbortVaultLock"></a>

 
+ [完成保存庫鎖定 (POST lockId)](api-CompleteVaultLock.md)

 
+ [取得保存庫鎖定 (GET 鎖定政策)](api-GetVaultLock.md)

 
+ [啟動保存庫鎖定 (POST 鎖定政策)](api-InitiateVaultLock.md)

## 另請參閱
<a name="api-AbortVaultLock-SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/abort-vault-lock.html) 

# 新增標籤至保存庫 (POST 標籤新增)
<a name="api-AddTagsToVault"></a>

該作業將指定的標籤新增到保存庫。每個標籤皆包含鍵與值。每個保存庫最多可擁有 50 個標籤。如果您的請求會導致超出保存庫的標籤限制，則該作業會擲出 `LimitExceededException` 錯誤。

如果標籤已存在於指定金鑰下的保存庫，則現有的索引鍵值將會被覆寫。如需標籤的詳細資訊，請參閱[標記 Amazon Glacier 資源](tagging.md)。

## 請求語法
<a name="api-AddTagsToVault-requestSyntax"></a>

若要將標籤新增到保存庫，請將 HTTP POST 請求傳送到標籤 URI，如以下語法範例所示。

```
 1. POST /AccountId/vaults/vaultName/tags?operation=add HTTP/1.1
 2. Host: glacier.Region.amazonaws.com
 3. Date: Date
 4. Authorization: SignatureValue
 5. Content-Length: Length
 6. x-amz-glacier-version: 2012-06-01
 7. 			
 8. {
 9.    "Tags": 
10.       {
11.          "string": "string",
12.          "string": "string"
13.       }        
14. }
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID 相符。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

## 請求參數
<a name="api-AddTagsToVault-requestParameters"></a>


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
|  operation=add  |  單一查詢字串參數 `operation` 的值為 `add`，以將其與 [從保存庫移除標籤 (POST tags remove)](api-RemoveTagsFromVault.md) 做區分。  |  是  | 

### 請求標頭
<a name="api-AddTagsToVault-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-AddTagsToVault-requests-elements"></a>

請求內文包含以下 JSON 欄位。

 

**Tags (標籤)**  
此標籤新增到保存庫。每個標籤皆包含鍵與值。此數值可以是空字串。  
 *類型：*字串到字串對應   
 *長度限制：*最小長度為 1。長度上限為 10。  
 *必要*：是 

## 回應
<a name="api-AddTagsToVault-responses"></a>

如果操作請求成功，則服務會傳回 HTTP `204 No Content` 回應。

### 語法
<a name="api-AddTagsToVault-response-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-AddTagsToVault-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-AddTagsToVault-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-AddTagsToVault-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-AddTagsToVault-examples"></a>

### 範例請求
<a name="api-AddTagsToVault-example-request"></a>

以下範例傳送帶有標籤的 HTTP POST 以新增至保存庫。

```
 1. POST /-/vaults/examplevault/tags?operation=add HTTP/1.1
 2. Host: glacier.us-west-2.amazonaws.com
 3. x-amz-Date: 20170210T120000Z
 4. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
 5. Content-Length: length
 6. x-amz-glacier-version: 2012-06-01
 7. 			
 8. {
 9.   "Tags": 
10.     {
11.        "examplekey1": "examplevalue1",
12.        "examplekey2": "examplevalue2"
13.     }        
14. }
```

### 回應範例
<a name="api-AddTagsToVault-example-response"></a>

如果請求成功，Amazon Glacier 會傳回 `HTTP 204 No Content`，如下列範例所示。

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:02:00 GMT
```

## 相關章節
<a name="related-sections-AddTagsToVault"></a>

 
+ [列出文件庫的標籤 (GET 標籤)](api-ListTagsForVault.md)

 
+ [從保存庫移除標籤 (POST tags remove)](api-RemoveTagsFromVault.md)

## 另請參閱
<a name="api-AddTagsToVault-SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/add-tags-to-vault.html) 

# 建立保存庫 (PUT 保存庫)
<a name="api-vault-put"></a>

## 說明
<a name="api-vault-put-description"></a>

此作業將使用指定的名稱建立新的保存庫。  保存庫的名稱在 的 AWS 區域內必須是唯一的 AWS 帳戶。您可以為每個帳戶建立最多 1,000 個保存庫。如需建立更多保存庫的資訊，請前往 [Amazon Glacier 產品詳細資訊頁面](https://aws.amazon.com/glacier)。

命名保存庫時必須使用以下準則。

 
+  名稱長度可介於 1 到 255 個字元之間。
+ 有效字元為 a-z、A-Z、0-9、'\$1' (底線)、'-' (連字號) 和 '.' (句號)。

此操作是等冪的，您可以多次傳送相同的請求，而且在 Amazon Glacier (Amazon Glacier) 第一次建立指定的保存庫之後不會進一步生效。

## 請求
<a name="api-vault-put-requests"></a>

### 語法
<a name="api-vault-put-requests-syntax"></a>

若要建立保存庫，請將 HTTP PUT 請求傳送到要建立的保存庫 URI 。

```
1. PUT /AccountId/vaults/VaultName HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. Content-Length: Length
6. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須符合與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-vault-put-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-vault-put-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-vault-put-requests-elements"></a>

此操作的請求內文必須為空 (0 位元組)。

## 回應
<a name="api-vault-put-responses"></a>

### 語法
<a name="api-vault-putresponse-syntax"></a>

```
HTTP/1.1 201 Created
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Location: Location
```

### 回應標頭
<a name="api-vault-put-responses-headers"></a>

成功的回應除了所有作業通用的回應標頭之外，還包含下列回應標頭。如需常見回應標頭的詳細資訊，請參閱[常見回應標頭](api-common-response-headers.md)。


|  名稱  |  描述 | 
| --- | --- | 
| `Location`  | 建立的保存庫的相對 URI 路徑。 類型：字串 | 

### 回應內文
<a name="api-vault-put-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-vault-put-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-vault-put-examples"></a>

### 範例請求
<a name="api-vault-put-example-request"></a>

以下範例傳送 HTTP PUT 請求來建立名為 `examplevault` 的保存庫。

```
1. PUT /-/vaults/examplevault HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Content-Length: 0
6. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-vault-put-example-response"></a>

Amazon Glacier 會建立保存庫，並在 `Location`標頭中傳回保存庫的相對 URI 路徑。無論帳戶 ID 或連字號 ('`Location`') 是否在請求中指定，帳戶 ID 一律會顯示在 `-` 標頭中。

```
1. HTTP/1.1 201 Created
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:02:00 GMT
4. Location: /111122223333/vaults/examplevault
```

## 相關章節
<a name="related-sections-vault-put"></a>

 
+ [「列出保存庫」(GET 保存庫)](api-vaults-get.md)
+ [刪除文件庫 (DELETE 文件庫)](api-vault-delete.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

## 另請參閱
<a name="vault-put-SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/create-vault.html) 

# 完成保存庫鎖定 (POST lockId)
<a name="api-CompleteVaultLock"></a>

## 說明
<a name="api-CompleteVaultLock-description"></a>

此作業透過將保存庫鎖定從 `InProgress` 狀態轉移為 `Locked` 狀態來完成保存庫鎖定程序，這會導致保存庫鎖定政策無法變更。透過呼叫 `InProgress`，保存庫鎖定進入 [啟動保存庫鎖定 (POST 鎖定政策)](api-InitiateVaultLock.md) 狀態。您可以透過呼叫 [取得保存庫鎖定 (GET 鎖定政策)](api-GetVaultLock.md) 來獲得保存庫鎖定的狀態。如需保存庫鎖定程序的詳細資訊，請參閱[Amazon Glacier 保存庫鎖定](vault-lock.md)。

此為等冪操作。如果保存庫鎖定處於 `Locked` 狀態並且提供的鎖定 ID 與最初用於鎖定保存庫的鎖定 ID 符合，則該請求一律成功。

如果保存庫鎖定處於 `Locked` 狀態時在請求中傳遞了無效的鎖定 ID，則該作業將傳回 `AccessDeniedException` 錯誤。如果保存庫鎖定處於 `InProgress` 狀態時在請求中傳遞了無效的鎖定 ID，則該作業將擲出 `InvalidParameter` 錯誤。

## 請求
<a name="api-CompleteVaultLock-requests"></a>

要完成保存庫鎖定程序，請使用有效的鎖定 ID 將HTTP `POST` 請求傳送到保存庫的 `lock-policy` 子資源的 URI。

### 語法
<a name="api-CompleteVaultLock-requests-syntax"></a>

```
1. POST /AccountId/vaults/vaultName/lock-policy/lockId HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. Content-Length: Length
6. x-amz-glacier-version: 2012-06-01
```

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID 相符。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

 此 `lockId` 值是從 [啟動保存庫鎖定 (POST 鎖定政策)](api-InitiateVaultLock.md) 請求取得的鎖定 ID 。

### 請求參數
<a name="api-CompleteVaultLock-requestParameters"></a>

#### 請求標頭
<a name="api-CompleteVaultLock-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

#### 請求主體
<a name="api-CompleteVaultLock-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-CompleteVaultLock-responses"></a>

如果操作請求成功，則服務會傳回 HTTP `204 No Content` 回應。

### 語法
<a name="api-CompleteVaultLock-response-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-CompleteVaultLock-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-CompleteVaultLock-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-CompleteVaultLock-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-CompleteVaultLock-examples"></a>

### 範例請求
<a name="api-CompleteVaultLock-example-request"></a>

以下範例使用鎖定 ID 傳送 HTTP POST 請求來完成保存庫鎖定程序。

```
1. POST /-/vaults/examplevault/lock-policy/AE863rKkWZU53SLW5be4DUcW HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
5. Content-Length: length
6. x-amz-glacier-version: 2012-06-01
```

### 回應範例
<a name="api-CompleteVaultLock-example-response"></a>

如果請求成功，Amazon Glacier (Amazon Glacier) 會傳回`HTTP 204 No Content`回應，如下列範例所示。

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:02:00 GMT
```

## 相關章節
<a name="related-sections-CompleteVaultLock"></a>

 
+ [「中止保存庫鎖定」(DELETE 鎖定政策)](api-AbortVaultLock.md)

 
+ [取得保存庫鎖定 (GET 鎖定政策)](api-GetVaultLock.md)

 
+ [啟動保存庫鎖定 (POST 鎖定政策)](api-InitiateVaultLock.md)

## 另請參閱
<a name="api-CompleteVaultLock-SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/complete-vault-lock.html) 

# 刪除文件庫 (DELETE 文件庫)
<a name="api-vault-delete"></a>

## 說明
<a name="api-vault-delete-description"></a>

這個作業會刪除保存庫。Amazon Glacier (Amazon Glacier) 只有在保存庫中沒有根據上次清查的封存，且自上次清查以來沒有寫入保存庫時，才會刪除保存庫。如果未滿足上述任一條件，則保存庫刪除會失敗 （即不會移除保存庫），Amazon Glacier 會傳回錯誤。

您可以使用提供保存庫資訊[描述保存庫 (GET 保存庫)](api-vault-get.md)的操作，包括保存庫中的封存數量；不過，資訊是以 Amazon Glacier 上次產生的保存庫庫存為基礎。

此為等冪操作。

**注意**  
當您刪除文件庫，附加到文件庫的文件庫存取政策也會被刪除。如需保存庫存取政策的詳細資訊，請參閱「[保存庫存取政策](vault-access-policy.md)」。

## 請求
<a name="api-vault-delete-requests"></a>

若要刪除文件庫，請將 `DELETE` 請求傳送至文件庫資源 URI。

### 語法
<a name="api-vault-delete-requests-syntax"></a>

```
1. DELETE /AccountId/vaults/VaultName HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-vault-delete-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-vault-delete-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-vault-delete-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-vault-delete-responses"></a>

### 語法
<a name="api-vault-delete-response-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-vault-delete-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-vault-delete-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-vault-delete-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-vault-delete-examples"></a>

### 範例請求
<a name="api-vault-delete-example-request"></a>

以下範例刪除名為「`examplevault`」的文件庫。此範例請求是對於要刪除的資源 (文件庫) 的 URI 之 `DELETE` 請求。

```
1. DELETE /-/vaults/examplevault HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-vault-delete-example-response"></a>

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:02:00 GMT
```

## 相關章節
<a name="related-sections-vault-delete"></a>

 
+ [建立保存庫 (PUT 保存庫)](api-vault-put.md)
+ [「列出保存庫」(GET 保存庫)](api-vaults-get.md)
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

## 另請參閱
<a name="api-vault-delete-SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/delete-vault.html) 

# 刪除保存庫存取政策 (DELETE 存取政策)
<a name="api-DeleteVaultAccessPolicy"></a>

## Description
<a name="api-DeleteVaultAccessPolicy-description"></a>

這個作業會刪除與指定保存庫關聯的存取政策。操作最終會一致，也就是說，Amazon Glacier (Amazon Glacier) 可能需要一些時間才能完全移除存取政策，而且傳送刪除請求後，您可能會在短時間內看到政策的效果。

此為等冪操作。即使沒有與保存庫關聯的政策，也可以多次叫用刪除。如需保存庫存取政策的詳細資訊，請參閱「[保存庫存取政策](vault-access-policy.md)」。

## 要求
<a name="api-DeleteVaultAccessPolicy-requests"></a>

若要刪除目前保存庫存取政策，請將 HTTP `DELETE` 請求傳送到保存庫 `access-policy` 子資源的 URI。

### 語法
<a name="api-DeleteVaultAccessPolicy-requests-syntax"></a>

```
1. DELETE /AccountId/vaults/vaultName/access-policy HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-DeleteVaultAccessPolicy-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-DeleteVaultAccessPolicy-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-DeleteVaultAccessPolicy-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-DeleteVaultAccessPolicy-responses"></a>

在回應中，如果成功刪除政策，則 Amazon Glacier 會傳回 `204 No Content`。

### 語法
<a name="api-DeleteVaultAccessPolicy-responses-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-DeleteVaultAccessPolicy-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-DeleteVaultAccessPolicy-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-DeleteVaultAccessPolicy-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-DeleteVaultAccessPolicy-examples"></a>

以下範例示範如何刪除保存庫存取政策。

### 範例請求
<a name="api-DeleteVaultAccessPolicy-example-request"></a>

在這個範例中，將 `DELETE` 請求傳送到名為 **examplevault** 的保存庫的 `access-policy` 子資源。

```
1. DELETE /-/vaults/examplevault/access-policy HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
5. x-amz-glacier-version: 2012-06-01
```

### 回應範例
<a name="api-DeleteVaultAccessPolicy-example-response"></a>

為了回應，如果成功刪除政策，Amazon Glacier 會傳回 `204 No Content`，如下列範例所示。

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
```

## 相關章節
<a name="related-sections-DeleteVaultAccessPolicy"></a>

 
+ [取得文件庫存取政策 (GET 存取政策)](api-GetVaultAccessPolicy.md)

 
+ [設定保存庫存取政策 (PUT 存取政策)](api-SetVaultAccessPolicy.md)

## 另請參閱
<a name="api-DeleteVaultAccessPolicy-SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/delete-vault-access-policy.html) 

# 刪除保存庫通知 (DELETE 通知的組態)
<a name="api-vault-notifications-delete"></a>

## Description
<a name="api-vault-notifications-delete-description"></a>

此操作將刪除為 [設定保存庫通知組態 (PUT 通知的組態)](api-vault-notifications-put.md) 設定的通知組態。操作最終會一致，也就是說，Amazon Glacier (Amazon Glacier) 可能需要一些時間才能完全停用通知，而且傳送刪除請求後，您可能會在短時間內收到一些通知。

## 要求
<a name="api-vault-notifications-delete-requests"></a>

要刪除保存庫的通知組態，請向保存庫的 `DELETE` 子資源發送 `notification-configuration` 請求。

### 語法
<a name="api-vault-notifications-delete-requests-syntax"></a>

```
1. DELETE /AccountId/vaults/VaultName/notification-configuration HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-vault-notifications-delete-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-vault-notifications-delete-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-vault-notifications-delete-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-vault-notifications-delete-responses"></a>

### 語法
<a name="api-vault-notifications-delete-responses-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-vault-notifications-delete-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-vault-notifications-delete-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-vault-notifications-delete-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-vault-notifications-delete-examples"></a>

以下範例示範如何刪除保存庫的通知組態。

### 範例請求
<a name="api-vault-notifications-delete-example-request"></a>

在這個範例中，將 `DELETE` 請求傳送到名為 `notification-configuration` 的保存庫的 `examplevault` 子資源。

```
1. DELETE /111122223333/vaults/examplevault/notification-configuration HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z 
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-vault-notifications-delete-example-response"></a>

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
```

## 相關章節
<a name="related-sections-vault-notifications-delete"></a>

 
+ [取得文件庫通知 (GET 通知的組態)](api-vault-notifications-get.md)
+ [設定保存庫通知組態 (PUT 通知的組態)](api-vault-notifications-put.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

## 另請參閱
<a name="api-vault-notifications-delete_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/delete-vault-notifications.html) 

# 描述保存庫 (GET 保存庫)
<a name="api-vault-get"></a>

## 說明
<a name="api-vault-get-description"></a>

這個作業會傳回有關保存庫的資訊，包括 Amazon Resource Name (ARN)、保存庫建立日期、保存庫內含的封存數量，以及保存庫中所有封存的大小總計。封存數量及其總大小截至 Amazon Glacier (Amazon Glacier) 產生的最後一個保存庫庫存為止 （請參閱 [在 Amazon Glacier 中使用保存庫](working-with-vaults.md))。Amazon Glacier 大約每天產生保存庫庫存。這表示如果您新增或移除保存庫的封存，然後立即傳送描述保存庫請求、回應可能不會反映變更。

## 請求
<a name="api-vault-get-requests"></a>

若要取得有關保存庫的資訊，請傳送 `GET` 請求至特定保存庫資源的 URI。

### 語法
<a name="api-vault-get-requests-syntax"></a>

```
1. GET /AccountId/vaults/VaultName HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-vault-get-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-vault-get-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-vault-get-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-vault-get-responses"></a>

### 語法
<a name="api-vault-get-responses-syntax"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: Length

{
  "CreationDate" : String,
  "LastInventoryDate" : String,
  "NumberOfArchives" : Number,
  "SizeInBytes" : Number,
  "VaultARN" : String,
  "VaultName" : String
}
```

### 回應標頭
<a name="api-vault-get-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-vault-get-responses-elements"></a>

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

**CreationDate**  
建立保存庫時的 UTC 日期。  
*類型*：ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**LastInventoryDate**  
Amazon Glacier 完成最後一個保存庫庫存的 UTC 日期。如需有關啟動保存庫之庫存的詳細資訊，請參閱 [啟動任務 (POST 任務)](api-initiate-job-post.md)。  
*類型*：ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**NumberOfArchives**  
根據最後一個保存庫的庫存的保存庫封存數量。如果保存庫尚未執行庫存，此欄位將傳回 Null，例如，您只建立保存庫。  
*類型*：數字

**SizeInBytes**  
保存庫中的封存大小總計以位元組為單位，包括截至最後一個庫存日期的各封存成本。如果保存庫尚未執行庫存，此欄位將傳回 `null`，例如，您只建立保存庫。  
*類型*：數字

**VaultARN**  
保存庫的 Amazon Resource Name (ARN)。  
*類型：*字串

**VaultName**  
在建立時指定的保存庫名稱。保存庫名稱也包含在保存庫的 ARN 中。  
*類型：*字串

### 錯誤
<a name="api-vault-get-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-vault-get-examples"></a>

### 範例請求
<a name="api-vault-get-example-request"></a>

以下範例示範如何取得有關稱為 `examplevault` 之保存庫的資訊。

```
GET /-/vaults/examplevault 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
```

### 回應範例
<a name="api-vault-get-example-response"></a>

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:02:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 260
 6. 
 7. {
 8.   "CreationDate" : "2012-02-20T17:01:45.198Z",
 9.   "LastInventoryDate" : "2012-03-20T17:03:43.221Z",
10.   "NumberOfArchives" : 192,
11.   "SizeInBytes" : 78088912,
12.   "VaultARN" : "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault",
13.   "VaultName" : "examplevault"
14. }
```

## 相關章節
<a name="related-sections-vault-get"></a>

 
+ [建立保存庫 (PUT 保存庫)](api-vault-put.md)
+ [「列出保存庫」(GET 保存庫)](api-vaults-get.md)
+ [刪除文件庫 (DELETE 文件庫)](api-vault-delete.md)
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

## 另請參閱
<a name="api-vault-get_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/describe-vault.html) 

# 取得文件庫存取政策 (GET 存取政策)
<a name="api-GetVaultAccessPolicy"></a>

## Description
<a name="api-GetVaultAccessPolicy-description"></a>

此作業會擷取保存庫上設定的 `access-policy` 子資源，如需設定此子資源的詳細資訊，請參閱 [設定保存庫存取政策 (PUT 存取政策)](api-SetVaultAccessPolicy.md)。如果文件庫上沒有設定存取政策，則該操作會傳回 `404 Not found` 錯誤。如需保存庫存取政策的詳細資訊，請參閱「[保存庫存取政策](vault-access-policy.md)」。

## 要求
<a name="api-GetVaultAccessPolicy-requests"></a>

若要傳回目前文件庫存取政策，請將 HTTP `GET` 請求傳送到文件庫的 `access-policy` 子資源的 URI。

### 語法
<a name="api-GetVaultAccessPolicy-requests-syntax"></a>

```
1. GET /AccountId/vaults/vaultName/access-policy HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-GetVaultAccessPolicy-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-GetVaultAccessPolicy-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-GetVaultAccessPolicy-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-GetVaultAccessPolicy-responses"></a>

為了回應，Amazon Glacier (Amazon Glacier) 會在回應內文中傳回 JSON 格式的保存庫存取政策。

### 語法
<a name="api-GetVaultAccessPolicy-responses-syntax"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: length
				
{
  "Policy": "string"
}
```

### 回應標頭
<a name="api-GetVaultAccessPolicy-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-GetVaultAccessPolicy-responses-elements"></a>

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

 **政策**   
保存庫存取政策做為 JSON 字串，使用 "\$1" 做為逸出字元。  
 類型：字串

### 錯誤
<a name="api-GetVaultAccessPolicy-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-GetVaultAccessPolicy-examples"></a>

以下範例示範如何取得文件庫存取政策。

### 範例請求
<a name="api-GetVaultAccessPolicy-example-request"></a>

在這個範例中，將 `GET` 請求傳送到保存庫的 `access-policy` 子資源的 URI。

```
1. GET /-/vaults/examplevault/access-policy HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-GetVaultAccessPolicy-example-response"></a>

如果請求成功，Amazon Glacier 會在回應內文中以 JSON 字串的形式傳回保存庫存取政策。傳回的 JSON 字串使用 "\$1" 做為逸出字元，如 [設定保存庫存取政策 (PUT 存取政策)](api-SetVaultAccessPolicy.md) 範例中所示。不過，以下範例顯示傳回的 JSON 字串，無需逸出字元即可讀取。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: application/json
 5. Content-Length: length
 6. 
 7. {
 8.   "Policy": "
 9.     {
10.       "Version": "2012-10-17",		 	 	 
11.       "Statement": [
12.         {
13.           "Sid": "allow-time-based-deletes",
14.           "Principal": {
15.             "AWS": "999999999999"
16.           },
17.           "Effect": "Allow",
18.           "Action": "glacier:Delete*",
19.           "Resource": [
20.             "arn:aws:glacier:us-west-2:999999999999:vaults/examplevault"
21.           ],
22.           "Condition": {
23.             "DateGreaterThan": {
24.               "aws:CurrentTime": "2018-12-31T00:00:00Z"
25.             }
26.           }
27.         }
28.       ]
29.     }        
30.   "
31. }
```

## 相關章節
<a name="related-sections-GetVaultAccessPolicy"></a>

 
+ [刪除保存庫存取政策 (DELETE 存取政策)](api-DeleteVaultAccessPolicy.md)

 
+ [設定保存庫存取政策 (PUT 存取政策)](api-SetVaultAccessPolicy.md)

## 另請參閱
<a name="api-GetVaultAccessPolicy_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/get-vault-access-policy.html) 

# 取得保存庫鎖定 (GET 鎖定政策)
<a name="api-GetVaultLock"></a>

## Description
<a name="api-GetVaultLock-description"></a>

此操作從指定的保存的 `lock-policy` 子資源集中擷取以下屬性：
+ 保存庫上設定的保存庫鎖定政策。
+ 保存庫鎖定的狀態，它是 `InProgess` 或 `Locked`。
+ 當鎖定 ID 過期時。鎖定 ID 用於完成保存庫鎖定程序。
+ 當保存庫鎖定啟動並進入 `InProgress` 狀態時。

透過呼叫 `InProgress`，保存庫鎖定進入 [啟動保存庫鎖定 (POST 鎖定政策)](api-InitiateVaultLock.md) 狀態。透過呼叫 `Locked`，保存庫鎖定進入 [完成保存庫鎖定 (POST lockId)](api-CompleteVaultLock.md) 狀態。您可呼叫 [「中止保存庫鎖定」(DELETE 鎖定政策)](api-AbortVaultLock.md)，停止保存庫鎖定程序。如需保存庫鎖定程序的詳細資訊，請參閱[Amazon Glacier 保存庫鎖定](vault-lock.md)。

如果在保存庫沒有設定保存庫鎖定政策，則該作業將傳回 `404 Not found` 錯誤。如需保存庫鎖定政策的詳細資訊，請參閱[保存庫鎖定政策](vault-lock-policy.md)。

## 要求
<a name="api-GetVaultLock-requests"></a>

若要傳回目前保存庫鎖定政策和其他屬性，請將 HTTP `GET` 請求傳送到保存庫的 `lock-policy` 子資源的 URI，如以下語法範例所示。

### 語法
<a name="api-GetVaultLock-requests-syntax"></a>

```
1. GET /AccountId/vaults/vaultName/lock-policy HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-GetVaultLock-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-GetVaultLock-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-GetVaultLock-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-GetVaultLock-responses"></a>

為了回應，Amazon Glacier (Amazon Glacier) 會在回應內文中傳回 JSON 格式的保存庫存取政策。

### 語法
<a name="api-GetVaultLock-responses-syntax"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: length
				
{
  "Policy": "string",
  "State": "string",
  "ExpirationDate": "string",
  "CreationDate":"string"
}
```

### 回應標頭
<a name="api-GetVaultLock-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-GetVaultLock-responses-elements"></a>

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

 **政策**   
保存庫鎖定政策做為 JSON 字串，使用 "\$1" 做為逸出字元。  
 類型：字串

 **州**   
保存庫鎖定的狀態。  
 類型：字串  
 有效值：`InProgress``|Locked`

 **ExpirationDate**   
鎖定 ID 過期的 UTC 日期和時間。如果保存庫鎖定處於 `null` 狀態，則此值可以為 `Locked`。  
*類型*：ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

 **CreationDate**   
保存庫鎖定進入 `InProgress` 狀態的 UTC 日期和時間。  
*類型*：ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

### 錯誤
<a name="api-GetVaultLock-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-GetVaultLock-examples"></a>

以下範例示範如何取得保存庫鎖定政策。

### 範例請求
<a name="api-GetVaultLock-example-request"></a>

在這個範例中，將 `GET` 請求傳送到保存庫的 `lock-policy` 子資源的 URI。

```
1. GET /-/vaults/examplevault/lock-policy HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-GetVaultLock-example-response"></a>

如果請求成功，Amazon Glacier 會在回應內文中以 JSON 字串的形式傳回保存庫存取政策。傳回的 JSON 字串使用 "\$1" 做為逸出字元，如 [啟動保存庫鎖定 (POST 鎖定政策)](api-InitiateVaultLock.md) 範例請求所示。不過，以下範例顯示傳回的 JSON 字串，無需逸出字元即可讀取。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: application/json
 5. Content-Length: length
 6. 
 7. {
 8.   "Policy": "
 9.     {
10.       "Version": "2012-10-17",		 	 	 
11.       "Statement": [
12.         {
13.           "Sid": "Define-vault-lock",
14.           "Principal": {
15.             "AWS": "arn:aws:iam::999999999999:root"
16.           },
17.           "Effect": "Deny",
18.           "Action": "glacier:DeleteArchive",
19.           "Resource": [
20.             "arn:aws:glacier:us-west-2:999999999999:vaults/examplevault"
21.           ],
22.           "Condition": {
23.             "NumericLessThanEquals": {
24.               "glacier:ArchiveAgeInDays": "365"
25.             }
26.           }
27.         }
28.       ]
29.     }
30.   ",
31.   "State": "InProgress",
32.   "ExpirationDate": "exampledate",
33.   "CreationDate": "exampledate"  
34. }
```

## 相關章節
<a name="related-sections-GetVaultLock"></a>

 
+ [「中止保存庫鎖定」(DELETE 鎖定政策)](api-AbortVaultLock.md)

 
+ [完成保存庫鎖定 (POST lockId)](api-CompleteVaultLock.md)

 
+ [啟動保存庫鎖定 (POST 鎖定政策)](api-InitiateVaultLock.md)

## 另請參閱
<a name="api-GetVaultLock_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/get-vault-lock.html) 

# 取得文件庫通知 (GET 通知的組態)
<a name="api-vault-notifications-get"></a>

## Description
<a name="api-vault-notifications-get-description"></a>

此操作擷取在文件庫 (請參閱 `notification-configuration` 上設定的 [設定保存庫通知組態 (PUT 通知的組態)](api-vault-notifications-put.md) 子資源。如果未設定文件庫的通知組態，則操作將傳回 `404 Not Found` 錯誤。如需文件庫通知的詳細資訊，請參閱 [在 Amazon Glacier 中設定保存庫通知](configuring-notifications.md)。

## 要求
<a name="api-vault-notifications-get-requests"></a>

要擷取通知組態資訊，請向文件庫的 `GET` 子資源的 URI 發送 `notification-configuration` 請求。

### 語法
<a name="api-vault-notifications-get-requests-syntax"></a>

```
1. GET /AccountId/vaults/VaultName/notification-configuration HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-vault-notifications-get-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-vault-notifications-get-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-vault-notifications-get-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-vault-notifications-get-responses"></a>

### 語法
<a name="api-vault-notifications-get-responses-syntax"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: length
{
  "Events": [
    String,
    ...
  ],
  "SNSTopic": String
}
```

### 回應標頭
<a name="api-vault-notifications-get-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-vault-notifications-get-responses-elements"></a>

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

 

**事件**  
一或多個事件的清單，Amazon Glacier (Amazon Glacier) 會將通知傳送至指定的 Amazon SNS 主題。如需有關可將文件庫設定為發佈通知的文件庫事件的詳細資訊，請參閱 [設定保存庫通知組態 (PUT 通知的組態)](api-vault-notifications-put.md)。  
*類型*：陣列

**SNSTopic**  
Amazon Simple Notification Service (Amazon SNS) 主題 Amazon Resource Name (ARN)。如需詳細資訊，請參閱《*Amazon Simple Notification Service 入門指南*》中的 [Amazon SNS 入門](https://docs.aws.amazon.com/sns/latest/gsg/Welcome.html)。  
*類型：*字串

### 錯誤
<a name="api-vault-notifications-get-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-vault-notifications-get-examples"></a>

以下範例示範如何擷取文件庫的通知組態。

### 範例請求
<a name="api-vault-notifications-get-example-request"></a>

在這個範例中，將 `GET` 請求傳送到文件庫的 `notification-configuration` 子資源。

```
1. GET /-/vaults/examplevault/notification-configuration HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-vault-notifications-get-example-response"></a>

成功的回應以 JSON 格式顯示回應內文中的稽核記錄組態文件。此範例中的此設定示範如何將兩個事件 (`ArchiveRetrievalCompleted` 和 `InventoryRetrievalCompleted`) 的通知傳送到 Amazon SNS 主題 `arn:aws:sns:us-west-2:012345678901:mytopic`。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 150
 6.   
 7. {
 8.   "Events": [
 9.     "ArchiveRetrievalCompleted",
10.     "InventoryRetrievalCompleted"
11.   ],
12.   "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic"
13. }
```

## 相關章節
<a name="related-sections-vault-notifications-get"></a>

 
+ [刪除保存庫通知 (DELETE 通知的組態)](api-vault-notifications-delete.md)
+ [設定保存庫通知組態 (PUT 通知的組態)](api-vault-notifications-put.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

## 另請參閱
<a name="api-vault-notifications-get_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/get-vault-notifications.html) 

# 啟動保存庫鎖定 (POST 鎖定政策)
<a name="api-InitiateVaultLock"></a>

## 說明
<a name="api-InitiateVaultLock-description"></a>

這個作業透過執行以下動作來啟動保存庫鎖定程序：
+ 在指定的保存庫上安裝保存庫鎖定政策。
+ 將保存庫鎖定的鎖定狀態設定為 `InProgress`。
+ 傳回用於完成保存庫鎖定程序的鎖定 ID。

您可以為每個保存庫設定保存庫鎖定政策，並且該政策的大小最多可達 20 KB。如需保存庫鎖定政策的詳細資訊，請參閱[保存庫鎖定政策](vault-lock-policy.md)。

保存庫鎖定進入 `InProgress` 狀態後，您必須在 24 小時內完成保存庫鎖定程序。24 小時視窗結束後，鎖定 ID 到期，保存庫自動結束 `InProgress` 狀態，並且從保存庫中刪除保存庫鎖定政策。透過將保存庫鎖定狀態設定為 [完成保存庫鎖定 (POST lockId)](api-CompleteVaultLock.md)，呼叫 `Locked` 以完成保存庫鎖定程序。

**注意**  
保存庫鎖定處於 `Locked` 狀態後，您無法為保存庫啟動新的保存庫鎖定。

您可呼叫 [「中止保存庫鎖定」(DELETE 鎖定政策)](api-AbortVaultLock.md)，停止保存庫鎖定程序。您可以透過呼叫 [取得保存庫鎖定 (GET 鎖定政策)](api-GetVaultLock.md) 來取得保存庫鎖定的狀態。如需保存庫鎖定程序的詳細資訊，請參閱[Amazon Glacier 保存庫鎖定](vault-lock.md)。

如果在保存庫鎖定處於 `InProgress` 狀態時呼叫此作業，該作業將傳回 `AccessDeniedException` 錯誤。當保存庫鎖定處於 `InProgress` 狀態時，必須先呼叫 [「中止保存庫鎖定」(DELETE 鎖定政策)](api-AbortVaultLock.md)，才能啟動新的保存庫鎖定政策。

## 請求
<a name="api-InitiateVaultLock-requests"></a>

若要啟動保存庫鎖定政策，請將 HTTP `POST` 請求傳送到保存庫的 `lock-policy` 子資源的 URI，如以下語法範例所示。

### 語法
<a name="api-InitiateVaultLock-requests-syntax"></a>

```
 1. POST /AccountId/vaults/vaultName/lock-policy HTTP/1.1
 2. Host: glacier.Region.amazonaws.com
 3. Date: Date
 4. Authorization: SignatureValue
 5. Content-Length: Length
 6. x-amz-glacier-version: 2012-06-01
 7. 			
 8. {
 9.   "Policy": "string"
10. }
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID 相符。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-InitiateVaultLock-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-InitiateVaultLock-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-InitiateVaultLock-requests-elements"></a>

請求內文包含以下 JSON 欄位。

 **政策**   
保存庫鎖定政策做為 JSON 字串，使用 "\$1" 做為逸出字元。  
 類型：字串   
 必要：是

## 回應
<a name="api-InitiateVaultLock-responses"></a>

如果接受政策，Amazon Glacier (Amazon Glacier) 會傳回`HTTP 201 Created`回應。

### 語法
<a name="api-InitiateVaultLock-response-syntax"></a>

```
HTTP/1.1 201 Created
x-amzn-RequestId: x-amzn-RequestId
Date: Date
x-amz-lock-id: lockId
```

### 回應標頭
<a name="api-InitiateVaultLock-responses-headers"></a>

成功的回應除了所有作業通用的回應標頭之外，還包含下列回應標頭。如需常見回應標頭的詳細資訊，請參閱[常見回應標頭](api-common-response-headers.md)。


|  名稱  |  描述  | 
| --- | --- | 
|  x-amz-lock-id  |  鎖定 ID 用於完成保存庫鎖定程序。 類型：字串  | 

### 回應內文
<a name="api-InitiateVaultLock-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-InitiateVaultLock-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-InitiateVaultLock-examples"></a>

### 範例請求
<a name="api-InitiateVaultLock-example-request"></a>

以下範例是發送 HTTP `PUT` 請求至保存庫的`lock-policy` 子資源的 URI。`Policy` JSON 字串使用 "\$1" 做為逸出字元。

```
1. PUT /-/vaults/examplevault/lock-policy HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
5. Content-Length: length
6. x-amz-glacier-version: 2012-06-01
7. 
8. {"Policy":"{\"Version\":\"2012-10-17\",		 	 	 \"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}"}
```

### 回應範例
<a name="api-InitiateVaultLock-example-response"></a>

如果請求成功，Amazon Glacier 會傳回`HTTP 201 Created`回應，如下列範例所示。

```
1. HTTP/1.1 201 Created
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:02:00 GMT
4. x-amz-lock-id: AE863rKkWZU53SLW5be4DUcW
```

## 相關章節
<a name="related-sections-InitiateVaultLock"></a>

 
+ [「中止保存庫鎖定」(DELETE 鎖定政策)](api-AbortVaultLock.md)

 
+ [完成保存庫鎖定 (POST lockId)](api-CompleteVaultLock.md)

 
+ [取得保存庫鎖定 (GET 鎖定政策)](api-GetVaultLock.md)

## 另請參閱
<a name="api-InitiateVaultLock_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/initiate-vault-lock.html) 

# 列出文件庫的標籤 (GET 標籤)
<a name="api-ListTagsForVault"></a>

此操作列出了附加到文件庫的所有標籤。如果沒有標籤，該操作傳回空的對應。如需標籤的詳細資訊，請參閱[標記 Amazon Glacier 資源](tagging.md)。

## 請求語法
<a name="api-ListTagsForVault-RequestSyntax"></a>

要列出文件庫的標籤，請將 HTTP GET 請求傳送到標籤 URI，如以下語法範例所示。

```
1. GET /AccountId/vaults/vaultName/tags HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID 相符。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

## 請求參數
<a name="api-ListTagsForVault-RequestParameters"></a>

此操作不使用請求參數。

## 請求標頭
<a name="api-ListTagsForVault-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

## 請求主體
<a name="api-ListTagsForVault-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-ListTagsForVault-responses"></a>

如果操作成功，則服務傳回 HTTP `200 OK` 回應。

### 回應語法
<a name="api-ListTagsForVault-ResponseSyntax"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: Length
{
   "Tags": 
      {
         "string" : "string",
         "string" : "string"
      }
}
```

### 回應標頭
<a name="api-ListTagsForVault-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-ListTagsForVault-body"></a>

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

**Tags (標籤)**  <a name="Glacier-ListTagsForVault-response-Tags"></a>
此標籤附加到文件庫。每個標籤皆包含鍵與值。  
 *類型：*字串到字串對應   
 *必要*：是 

### 錯誤
<a name="api-ListTagsForVault--errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-ListTagsForVault-examples"></a>

### 範例：列出文件庫的標籤
<a name="api-ListTagsForVault-example1"></a>

以下範例列出文件庫的標籤。

#### 範例請求
<a name="api-ListTagsForVault-example1-request"></a>

在這個範例中，傳送 GET 請求以從指定的文件庫中擷取標籤清單。

```
1. GET /-/vaults/examplevault/tags HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-ListTagsForVault-example1-response"></a>

如果請求成功，Amazon Glacier (Amazon Glacier) 會傳回保存庫的標籤`HTTP 200 OK`清單，如下列範例所示。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:02:00 GMT
 4. Content-Type: application/json
 5. Content-Length: length
 6. 
 7. {
 8.    "Tags",
 9.       {
10.          "examplekey1": "examplevalue1",
11.          "examplekey2": "examplevalue2"
12.       }  
13. }
```

## 相關章節
<a name="related-sections-ListTagsForVault"></a>

 
+ [新增標籤至保存庫 (POST 標籤新增)](api-AddTagsToVault.md)

 
+ [從保存庫移除標籤 (POST tags remove)](api-RemoveTagsFromVault.md)

## 另請參閱
<a name="api-ListTagsForVault_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/list-tags-for-vault.html) 

# 「列出保存庫」(GET 保存庫)
<a name="api-vaults-get"></a>

## 說明
<a name="api-vaults-get-description"></a>

此作業列出了呼叫使用者帳戶擁有的所有保存庫。回應中傳回的清單是 ASCII 依保存庫名稱排序。

在預設情況下，這個操作會傳回每個請求的最多 10 個項目。如果要列出更多的保存庫，則回應內文中的 `marker` 欄位包含保存庫 Amazon Resource Name (ARN)，以便在該列表中繼續使用新的「列出保存庫」請求，否則 `marker` 欄位是 `null`。在下一個 List Vaults 請求中，您將 `marker` 參數設定為 Amazon Glacier (Amazon Glacier) 在先前 List Vaults 請求的回應中傳回的值。您可以透過在請求中指定 `limit` 參數來限制回應中傳回的文件庫數量。

## 請求
<a name="api-vaults-get-requests"></a>

若要取得保存庫清單，請向`GET`保存庫* 資源傳送 * 請求。

### 語法
<a name="api-vaults-get-requests-syntax"></a>

```
1. GET /AccountId/vaults HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID 相符。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-vaults-get-requests-parameters"></a>

這個作業會傳回以下請求參數。


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
|  limit  |  所要傳回的保存庫數量上限。預設限制為 10。傳回的保存庫數量可能少於指定的限制，但傳回的保存庫數量永遠不會超過限制。 類型：字串 限制：最小整數值為 1。最大整數值為 10。  |  否  | 
|  marker  |  用於分頁的字串。`marker` 指定保存庫 ARN，之後應該開始保存庫清單。(由 `marker` 指定的保存庫不包括在傳回的清單中。) 從之前的「列出保存庫」回應中取得 `marker` 值。只有在您繼續對之前的「列出保存庫」請求中開始的結果進行分頁時，才需要包含 `marker`。指定標記的空白值 (「」) 會傳回從第一個保存庫開始的保存庫清單。 類型：字串 限制條件：無  |  否  | 

### 請求標頭
<a name="api-vaults-get-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-vaults-get-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-vaults-get-responses"></a>

### 語法
<a name="api-vaults-get-responses-syntax"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: Length

{
  "Marker": String
  "VaultList": [ 
   {
    "CreationDate": String,
    "LastInventoryDate": String,
    "NumberOfArchives": Number,
    "SizeInBytes": Number,
    "VaultARN": String,
    "VaultName": String
   }, 
   ...
  ]
}
```

### 回應標頭
<a name="api-vaults-get-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-vaults-get-response-body"></a>

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

 

**CreationDate**  
建立保存庫的日期，以國際標準時間 (UTC) 為準。  
*類型*：字串 ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**LastInventoryDate**  
上次保存庫庫存的日期，以國際標準時間 (UTC) 為準。如果保存庫尚未執行庫存，此欄位可以為 null，例如，您剛剛建立保存庫。如需有關啟動保存庫之庫存的詳細資訊，請參閱 [啟動任務 (POST 任務)](api-initiate-job-post.md)。  
*類型*：ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**Marker**  
`vaultARN` 代表繼續分頁結果。您在另一個「列出保存庫」請求中使用 `marker` 來取得清單中的更多保存庫。如果沒有更多的保存庫，則此值為 `null`。  
*類型：*字串

**NumberOfArchives**  
截至上次庫存日期的保存庫中的封存數量。  
*類型*：數字

**SizeInBytes**  
保存庫中的所有封存大小總計以位元組為單位，包括截至最後一個庫存日期的各封存成本。  
*類型*：數字

**VaultARN**  
保存庫的 Amazon Resource Name (ARN)。  
*類型：*字串

**VaultList**  
物件陣列，每個物件提供保存庫的說明。  
*類型*：陣列

**VaultName**  
此保存庫名稱。  
*類型：*字串

### 錯誤
<a name="api-vaults-get-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-vaults-get-examples"></a>

### 範例：列出所有保存庫
<a name="api-vaults-get-example1"></a>

下列範例列出保存庫。由於在請求中未指定 `marker` 和d `limit` 參數，因此傳回最多 10 個保存庫。

#### 範例請求
<a name="api-vaults-get-example1-request"></a>

```
1. GET /-/vaults HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-vaults-get-example1-response"></a>

`Marker` 是 `null` 表明沒有更多的保存庫列出。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:02:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 497	
 6. 
 7. {
 8.   "Marker": null,
 9.   "VaultList": [ 
10.    {
11.     "CreationDate": "2012-03-16T22:22:47.214Z",
12.     "LastInventoryDate": "2012-03-21T22:06:51.218Z",
13.     "NumberOfArchives": 2,
14.     "SizeInBytes": 12334,
15.     "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault1",
16.     "VaultName": "examplevault1"
17.    }, 
18.    {
19.     "CreationDate": "2012-03-19T22:06:51.218Z",
20.     "LastInventoryDate": "2012-03-21T22:06:51.218Z",
21.     "NumberOfArchives": 0,
22.     "SizeInBytes": 0,
23.     "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault2",
24.     "VaultName": "examplevault2"
25.    },
26.    {
27.     "CreationDate": "2012-03-19T22:06:51.218Z",
28.     "LastInventoryDate": "2012-03-25T12:14:31.121Z",
29.     "NumberOfArchives": 0,
30.     "SizeInBytes": 0,
31.     "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault3",
32.     "VaultName": "examplevault3"
33.    } 
34.   ]
35. }
```

### 範例：部分保存庫清單
<a name="api-vaults-get-example2"></a>

以下範例傳回從 `marker` 指定的保存庫開始的兩個保存庫。

#### 範例請求
<a name="api-vaults-get-example2-request"></a>

```
1. GET /-/vaults?limit=2&marker=arn:aws:glacier:us-west-2:012345678901:vaults/examplevault1 HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-vaults-get-example2-response"></a>

清單中傳回兩個保存庫。`Marker` 包含保存庫 ARN 以在另一個「列出保存庫」請求中繼續分頁。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:02:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 497	
 6. 
 7. {
 8.   "Marker": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault3",
 9.   "VaultList": [ 
10.    {
11.     "CreationDate": "2012-03-16T22:22:47.214Z",
12.     "LastInventoryDate": "2012-03-21T22:06:51.218Z",
13.     "NumberOfArchives": 2,
14.     "SizeInBytes": 12334,
15.     "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault1",
16.     "VaultName": "examplevault1"
17.    }, 
18.    {
19.     "CreationDate": "2012-03-19T22:06:51.218Z",
20.     "LastInventoryDate": "2012-03-21T22:06:51.218Z",
21.     "NumberOfArchives": 0,
22.     "SizeInBytes": 0,
23.     "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault2",
24.     "VaultName": "examplevault2"
25.    }
26.   ]
27. }
```

## 相關章節
<a name="related-sections-vaults-get"></a>

 
+ [建立保存庫 (PUT 保存庫)](api-vault-put.md)
+ [刪除文件庫 (DELETE 文件庫)](api-vault-delete.md)
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

## 另請參閱
<a name="api-vaults-get_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/list-vaults.html) 

# 從保存庫移除標籤 (POST tags remove)
<a name="api-RemoveTagsFromVault"></a>

此作業會從附加到保存庫的一組標籤移除一或多個標籤。如需標籤的詳細資訊，請參閱[標記 Amazon Glacier 資源](tagging.md)。

此為等冪操作。作業將會成功，即使沒有標籤附加到保存庫。

## 請求語法
<a name="api-RemoveTagsFromVault-RequestSyntax"></a>

若要從保存庫移除標籤，請如以下語法範例所示，將 HTTP POST 請求傳送到標籤 URI。

```
POST /AccountId/vaults/vaultName/tags?operation=remove HTTP/1.1
Host: glacier.Region.amazonaws.com
Date: Date
Authorization: SignatureValue
Content-Length: Length
x-amz-glacier-version: 2012-06-01
{
   "TagKeys": [
      "string",
      "string"
   ]
}
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須符合與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

## 請求參數
<a name="api-RemoveTagsFromVault-RequestParameters"></a>


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
|  operation=remove  |  單一查詢字串參數 `operation` 的值為 `remove`，以將其與 [新增標籤至保存庫 (POST 標籤新增)](api-AddTagsToVault.md) 做區分。  |  是  | 

### 請求標頭
<a name="api-RemoveTagsFromVault-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-RemoveTagsFromVault-requests-elements"></a>

請求內文包含以下 JSON 欄位。

 

**TagKeys**  
標籤金鑰的清單。每個對應的標籤會從保存庫移除。  
 *類型：*字串的陣列  
 *長度限制條件：*清單中最少 1 個項目。清單中最多 10 個項目。  
 *必要*：是

## 回應
<a name="api-RemoveTagsFromVault-responses"></a>

如果動作成功，則服務會傳回具空的 HTTP 內文的 HTTP `204 No Content` 回應。

### 語法
<a name="api-RemoveTagsFromVault-response-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-RemoveTagsFromVault-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-RemoveTagsFromVault-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-RemoveTagsFromVault-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-RemoveTagsFromVault-examples"></a>

### 範例請求
<a name="api-RemoveTagsFromVault-example-request"></a>

以下範例會傳送 HTTP POST 請求以移除指定的標籤。

```
 1. POST /-/vaults/examplevault/tags?operation=remove HTTP/1.1
 2. Host: glacier.us-west-2.amazonaws.com
 3. x-amz-Date: 20170210T120000Z
 4. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
 5. Content-Length: length
 6. x-amz-glacier-version: 2012-06-01
 7. 			
 8. {
 9.    "TagsKeys": [
10.       "examplekey1",
11.       "examplekey2"
12.    ]        
13. }
```

### 回應範例
<a name="api-RemoveTagsFromVault-example-response"></a>

如果請求成功，Amazon Glacier (Amazon Glacier) 會傳回 `HTTP 204 No Content`，如下列範例所示。

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:02:00 GMT
```

## 相關章節
<a name="related-sections-RemoveTagsFromVault"></a>

 
+ [新增標籤至保存庫 (POST 標籤新增)](api-AddTagsToVault.md)

 
+ [列出文件庫的標籤 (GET 標籤)](api-ListTagsForVault.md)

## 另請參閱
<a name="api-RemoveTagsFromVault_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/remove-tags-from-vault.html) 

# 設定保存庫存取政策 (PUT 存取政策)
<a name="api-SetVaultAccessPolicy"></a>

## Description
<a name="api-SetVaultAccessPolicy-description"></a>

這個作業將設定保存庫的存取政策，並會覆寫現有的政策。要設定保存庫存取政策，傳送 `PUT` 請求到保存庫的 `access-policy` 子資源。您可以為每個保存庫設定存取政策，並且該政策的大小最多可達 20 KB。如需保存庫存取政策的詳細資訊，請參閱「[保存庫存取政策](vault-access-policy.md)」。

## 要求
<a name="api-SetVaultAccessPolicy-requests"></a>

### 語法
<a name="api-SetVaultAccessPolicy-requests-syntax"></a>

若要設定保存庫存取政策，請將 HTTP `PUT` 請求傳送到保存庫的 `access-policy` 子資源的 URI，如以下語法範例所示。

```
 1. PUT /AccountId/vaults/vaultName/access-policy HTTP/1.1
 2. Host: glacier.Region.amazonaws.com
 3. Date: Date
 4. Authorization: SignatureValue
 5. Content-Length: Length
 6. x-amz-glacier-version: 2012-06-01
 7. 			
 8. {
 9.   "Policy": "string"
10. }
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-SetVaultAccessPolicy-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-SetVaultAccessPolicy-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-SetVaultAccessPolicy-requests-elements"></a>

請求內文包含以下 JSON 欄位。

 **政策**   
保存庫存取政策做為 JSON 字串，使用 "\$1" 做為逸出字元。  
 類型：字串   
 必要：是

## 回應
<a name="api-SetVaultAccessPolicy-responses"></a>

為了回應，Amazon Glacier 會在接受政策`204 No Content`時傳回 。

### 語法
<a name="api-SetVaultAccessPolicy-response-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-SetVaultAccessPolicy-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-SetVaultAccessPolicy-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-SetVaultAccessPolicy-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-SetVaultAccessPolicy-examples"></a>

### 範例請求
<a name="api-SetVaultAccessPolicy-example-request"></a>

以下範例是發送 HTTP `PUT` 請求至保存庫的`access-policy` 子資源的 URI。`Policy` JSON 字串使用 "\$1" 做為逸出字元。

```
1. PUT /-/vaults/examplevault/access-policy HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
5. Content-Length: length
6. x-amz-glacier-version: 2012-06-01
7. 
8. {"Policy":"{\"Version\":\"2012-10-17\",		 	 	 \"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}"}
```

### 回應範例
<a name="api-SetVaultAccessPolicy-example-response"></a>

如果請求成功，Amazon Glacier (Amazon Glacier) 會傳回 `HTTP 204 No Content`，如下列範例所示。

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:02:00 GMT
```

## 相關章節
<a name="related-sections-SetVaultAccessPolicy"></a>

 
+ [刪除保存庫存取政策 (DELETE 存取政策)](api-DeleteVaultAccessPolicy.md)

 
+ [取得文件庫存取政策 (GET 存取政策)](api-GetVaultAccessPolicy.md)

## 另請參閱
<a name="api-SetVaultAccessPolicy_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/set-vault-access-policy.html) 

# 設定保存庫通知組態 (PUT 通知的組態)
<a name="api-vault-notifications-put"></a>

## Description
<a name="api-vault-notifications-put-description"></a>

擷取封存和保存庫庫存是 Amazon Glacier (Amazon Glacier) 中的非同步操作，您必須先啟動任務並等待任務完成，才能下載任務輸出。您可以設定保存庫，以在這些工作完成時，將訊息發佈到 Amazon Simple Notification Service (Amazon SNS) 主題。可以使用此作業在保存庫上設定通知組態。如需詳細資訊，請參閱[在 Amazon Glacier 中設定保存庫通知](configuring-notifications.md)。

要設定保存庫通知，傳送 PUT 請求到保存庫的 `notification-configuration` 子資源。通知組態特定於保存庫；因此，也被稱為保存庫子資源。請求應包含提供 Amazon Simple Notification Service (Amazon SNS) 主題的 JSON 文件，以及您希望 Amazon Glacier 將通知傳送至主題的事件。

可以設定保存庫以發佈以下保存庫事件的通知：

 
+ **`ArchiveRetrievalCompleted`：**當為封存擷取啟動的工作完成時，會發生此事件 ([啟動任務 (POST 任務)](api-initiate-job-post.md))。完成的工作的狀態可以是 `Succeeded` 或 `Failed`。傳送至 SNS 主題的通知與從 [描述任務 (GET JobID)](api-describe-job-get.md) 傳回的輸出相同。
+ **`InventoryRetrievalCompleted`：**當為庫存擷取啟動的工作完成時，會發生此事件 ([啟動任務 (POST 任務)](api-initiate-job-post.md))。完成的工作的狀態可以是 `Succeeded` 或 `Failed`。傳送至 SNS 主題的通知與從 [描述任務 (GET JobID)](api-describe-job-get.md) 傳回的輸出相同。

Amazon SNS 主題必須授予對該保存庫的許可，才能將通知發布到該主題。

## 要求
<a name="api-vault-notifications-put-requests"></a>

要在保存庫上設定通知組態，請將 PUT 請求傳送到保存庫的 `notification-configuration` 子資源的 URI。您可以在請求內文中指定組態。該設定包含 Amazon SNS 主題名稱和一連串觸發每個主題通知的事件。

### 語法
<a name="api-vault-notifications-put-requests-syntax"></a>

```
 1. PUT /AccountId/vaults/VaultName/notification-configuration HTTP/1.1
 2. Host: glacier.Region.amazonaws.com
 3. Date: Date
 4. Authorization: SignatureValue
 5. x-amz-glacier-version: 2012-06-01
 6. 
 7. {
 8.    "SNSTopic": String,
 9.    "Events":[String, ...] 
10. }
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-vault-notifications-put-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-vault-notifications-put-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-vault-notifications-put-requests-elements"></a>

 請求內文中的 JSON 包含以下欄位。

**事件**  
您希望 Amazon Glacier 傳送通知的一或多個事件陣列。  
*有效值*：`ArchiveRetrievalCompleted` \$1 `InventoryRetrievalCompleted`   
*必要*：是  
*類型*：陣列

**SNSTopic**  
Amazon SNS 主題 ARN。如需詳細資訊，請前往《Amazon Simple Notification Service 入門指南》**中的 [Amazon SNS 入門](https://docs.aws.amazon.com/sns/latest/gsg/Welcome.html)。  
*必要*：是  
*類型：*字串

## 回應
<a name="api-vault-notifications-put-responses"></a>

為了回應，`204 No Content`如果接受通知組態，Amazon Glacier (Amazon Glacier) 會傳回 。

### 語法
<a name="api-vault-notifications-put-responses-elements"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-vault-notifications-put-responses-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 回應內文
<a name="api-vault-notifications-put-responses-body"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-vault-notifications-put-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-vault-notifications-put-examples"></a>

以下範例示範如何設定保存庫通知。

### 範例請求
<a name="api-vault-notifications-put-example-request"></a>

以下請求設定 `examplevault` 通知設定，以便將兩個事件 (`ArchiveRetrievalCompleted` 和 `InventoryRetrievalCompleted`) 的通知傳送到 Amazon SNS 主題 `arn:aws:sns:us-west-2:012345678901:mytopic`。

```
 1. PUT /-/vaults/examplevault/notification-policy HTTP/1.1
 2. Host: glacier.us-west-2.amazonaws.com
 3. x-amz-Date: 20170210T120000Z
 4. x-amz-glacier-version: 2012-06-01
 5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
 6. 
 7. { 
 8.    "Events": ["ArchiveRetrievalCompleted", "InventoryRetrievalCompleted"],
 9.    "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic"       
10. }
```

### 回應範例
<a name="api-vault-notifications-put-example-response"></a>

成功的回應會傳回 `204 No Content`。

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
```

## 相關章節
<a name="related-sections-vault-notifications-put"></a>

 
+ [取得文件庫通知 (GET 通知的組態)](api-vault-notifications-get.md)
+ [刪除保存庫通知 (DELETE 通知的組態)](api-vault-notifications-delete.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

## 另請參閱
<a name="api-vault-notifications-put_SeeAlso"></a>

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/reference/glacier/set-vault-notifications.html) 

# 封存操作
<a name="archive-operations"></a>

以下是可用於 Amazon Glacier 的封存操作。

**Topics**
+ [刪除封存 (DELETE archive)](api-archive-delete.md)
+ [上傳封存 (POST 封存)](api-archive-post.md)

# 刪除封存 (DELETE archive)
<a name="api-archive-delete"></a>

## 說明
<a name="api-archive-delete-description"></a>

此作業會從保存庫刪除封存。您可以一次從保存庫刪除一個封存。若要刪除封存，您必須提在刪除請求中提供其封存 ID。您可以透過為包含封存的保存庫下載保存庫庫存來取得封存 ID。如需下載保存庫庫存的詳細資訊，請參閱[在 Amazon Glacier 中下載保存庫庫存](vault-inventory.md)。

在您刪除封存之後，您可能仍然能夠成功請求起始任務，擷取已刪除的封存，但封存擷取任務將會失敗。

根據以下情況，當您刪除封存時，進行中的封存 ID 擷取可能會也可能不會成功：

 
+ 如果封存擷取任務在 Amazon Glacier (Amazon Glacier) 收到刪除封存請求時主動準備資料以供下載，則封存擷取操作可能會失敗。
+ 如果封存擷取任務在 Amazon Glacier 收到刪除封存請求時已成功準備要下載的封存，您將可以下載輸出。

如需封存擷取的詳細資訊，請參閱 [在 Amazon Glacier 中下載封存](downloading-an-archive.md)。

此為等冪操作。嘗試刪除已刪除的封存不會導致錯誤。

## 請求
<a name="api-archive-delete-requests"></a>

為刪除封存，您傳送 `DELETE` 請求到封存資源 URI。

### 語法
<a name="api-archive-delete-requests-syntax"></a>

```
1. DELETE /AccountId/vaults/VaultName/archives/ArchiveID HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. x-amz-Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-archive-delete-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-archive-delete-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-archive-delete-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-archive-delete-responses"></a>

### 語法
<a name="api-archive-delete-responses-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-archive-delete-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-archive-delete-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-archive-delete-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-archive-delete-examples"></a>

以下範例示範如何從稱為 `examplevault` 之保存庫刪除封存。

### 範例請求
<a name="api-archive-delete-example-request"></a>

要刪除之封存的 ID 被指定為 `archives` 的子資源。

```
1. DELETE /-/vaults/examplevault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-archive-delete-example-response"></a>

如果請求成功，Amazon Glacier 會回應 `204 No Content` ，指出已刪除封存。

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
```

## 相關章節
<a name="related-sections-archive-delete"></a>

 
+ [啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md)
+ [上傳封存 (POST 封存)](api-archive-post.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 上傳封存 (POST 封存)
<a name="api-archive-post"></a>

## 說明
<a name="api-archive-post-description"></a>

此作業將封存新增到保存庫。如需成功上傳，您的資料要長期保留。為了回應，Amazon Glacier (Amazon Glacier) 會在回應的 `x-amz-archive-id`標頭中傳回封存 ID。您應該儲存傳回的封存 ID，以便稍後可以存取封存。

您必須提供正在上傳的資料的 SHA256 樹狀雜湊。如需有關運算 SHA256 樹雜湊的資訊，請參閱 [運算檢查總和](checksum-calculations.md)。

**注意**  
使用 API 時，只有「上傳封存」(POST 封存) 動作才需要 SHA256 樹雜湊。使用 時不需要 AWS CLI。

當上傳封存時，您可以選擇指定多達 1,024 可列印 ASCII 字元的封存說明。當您擷取封存或取得保存庫庫存時，Amazon Glacier 會傳回封存描述。Amazon Glacier 不會以任何方式解譯描述。封存說明不需要是唯一的。您不能使用說明來擷取或排序封存清單。

除了選用的封存描述之外，Amazon Glacier 不支援封存的任何其他中繼資料。封存 ID 是一個不透明的字元序列，您無法從中推斷出封存的任何含義。因此，您可以在用戶端維護封存的中繼資料。如需詳細資訊，請參閱[在 Amazon Glacier 中使用封存](working-with-archives.md)。

封存是不可變的。在您上傳封存後，您不能編輯封存或其說明。

## 請求
<a name="api-archive-post-requests"></a>

要上傳封存，請使用 HTTP `POST` 方法，並將請求範圍限定在要儲存封存的保存庫的 `archives` 子資源。請求必須包括封存承載大小、檢查總和(SHA256 樹狀雜湊)，並且可以選擇包含封存的說明。

### 語法
<a name="api-archive-post-requests-syntax"></a>

```
 1. POST /AccountId/vaults/VaultName/archives
 2. Host: glacier.Region.amazonaws.com
 3. x-amz-glacier-version: 2012-06-01
 4. Date: Date
 5. Authorization: SignatureValue
 6. x-amz-archive-description: Description
 7. x-amz-sha256-tree-hash: SHA256 tree hash
 8. x-amz-content-sha256: SHA256 linear hash
 9. Content-Length: Length
10. 
11. <Request body.>
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-archive-post-requests-parameters"></a>

此實作操作不使用請求參數。

### 請求標頭
<a name="api-archive-post-requests-headers"></a>

除了所有作業通用的請求標頭之外，此作業還會使用下列請求標頭。如需常見請求標頭的資訊，請參閱[常見請求標題](api-common-request-headers.md)。


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
| Content-Length  |  物件的大小 (位元組)。如需詳細資訊，請參閱 [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html\$1sec14.13](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13)。 類型：數字 預設：無 限制條件：無  |  是  | 
| x-amz-archive-description  |  正在上傳的封存的可選說明。它可以是純語言描述或您選擇指派的某個識別符。說明在封存中不必是唯一的。當您擷取保存庫庫存 (請參閱 [啟動任務 (POST 任務)](api-initiate-job-post.md)) 時，它將為其傳回的每個封存的說明包括在內。 類型：字串 預設：無 限制：說明必須小於或等於 1,024 字元。允許的字元是沒有控制代碼的 7 位元 ASCII，尤其 ASCII 值是 32-126 十進制或 0x20-0x7E 十六進制。  |  否  | 
| x-amz-content-sha256  |  承載的 SHA256-256 檢查總和 (線性雜湊)。這與您在 `x-amz-sha256-tree-hash` 標頭中指定的值不同。 類型：字串 預設：無 限制條件：無  |  是  | 
|  x-amz-sha256-tree-hash  |  承載的使用者計算的檢查總和，SHA256-256 樹狀雜湊。如需有關運算 SHA256 樹狀雜湊的資訊，請參閱 [運算檢查總和](checksum-calculations.md)。如果 Amazon Glacier 計算承載的不同檢查總和，則會拒絕請求。 類型：字串 預設：無 限制條件：無  |  是 | 

### 請求主體
<a name="api-archive-post-requests-elements"></a>

請求內文包含要上傳的資料。

## 回應
<a name="api-archive-post-responses"></a>

 為了回應，Amazon Glacier 會永久存放封存，並傳回封存 ID 的 URI 路徑。

### 語法
<a name="api-archive-post-response-syntax"></a>

```
1. HTTP/1.1 201 Created
2. x-amzn-RequestId: x-amzn-RequestId
3. Date: Date
4. x-amz-sha256-tree-hash: ChecksumComputedByAmazonGlacier
5. Location: Location
6. x-amz-archive-id: ArchiveId
```

### 回應標頭
<a name="api-archive-post-responses-headers"></a>

成功的回應除了所有作業通用的回應標頭之外，還包含下列回應標頭。如需常見回應標頭的詳細資訊，請參閱[常見回應標頭](api-common-response-headers.md)。


|  名稱  |  描述  | 
| --- | --- | 
|  Location  |  新加入的封存資源的相對 URI 路徑。 類型：字串  | 
|  x-amz-archive-id  |  此封存的 ID。此值也包含在 `Location` 標頭中。 類型：字串  | 
|  x-amz-sha256-tree-hash​  |  Amazon Glacier 計算的封存檢查總和。 類型：字串  | 

### 回應內文
<a name="api-archive-post-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-archive-post-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-archive-post-examples"></a>

### 範例請求
<a name="api-archive-post-examples-request"></a>

以下範例顯示上傳封存的請求。

```
 1. POST /-/vaults/examplevault/archives HTTP/1.1
 2. Host: glacier.us-west-2.amazonaws.com
 3. x-amz-Date: 20170210T120000Z
 4. x-amz-sha256-tree-hash: beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60
 5. x-amz-content-sha256: 7f2fe580edb35154041fa3d4b41dd6d3adaef0c85d2ff6309f1d4b520eeecda3
 6. Content-Length: 2097152
 7. x-amz-glacier-version: 2012-06-01
 8. Authorization: Authorization=AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-content-sha256;x-amz-date;x-amz-glacier-version,Signature=16b9a9e220a37e32f2e7be196b4ebb87120ca7974038210199ac5982e792cace
 9. 
10. <Request body (2097152 bytes).>
```

### 回應範例
<a name="api-archive-post-examples-response"></a>

以下成功回應的`Location`標頭可讓您取得 Amazon Glacier 指派給封存的 ID。

```
1. HTTP/1.1 201 Created
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
4. x-amz-sha256-tree-hash: beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60
5. Location: /111122223333/vaults/examplevault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId
6. x-amz-archive-id: NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId
```

## 相關章節
<a name="related-sections-api-archive-post"></a>

 
+ [在 Amazon Glacier 中使用封存](working-with-archives.md)
+ [上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)
+ [刪除封存 (DELETE archive)](api-archive-delete.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 分段上傳操作
<a name="multipart-archive-operations"></a>

以下是可用於 Amazon Glacier 的分段上傳操作。

**Topics**
+ [中止分段上傳 (DELETE uploadID)](api-multipart-abort-upload.md)
+ [完成分段上傳 (POST uploadID)](api-multipart-complete-upload.md)
+ [啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md)
+ [清單部分 (GET uploadID)](api-multipart-list-parts.md)
+ [列出分段上傳 (GET 分段 - 上傳)](api-multipart-list-uploads.md)
+ [分段上傳 (PUT uploadID)](api-upload-part.md)

# 中止分段上傳 (DELETE uploadID)
<a name="api-multipart-abort-upload"></a>

## Description
<a name="api-multipart-abort-upload-description"></a>

此分段上傳作業命令會停止由上傳 ID 識別的分段上傳。

中止分段上傳請求成功後，您不能使用上傳 ID 上傳更多部分或執行任何其他操作。停止已完成的分段上傳失敗。但是，停止已經停止的上傳動作將會在短時間內成功。

此為等冪操作。

如需有關分段上傳的資訊，請參閱[上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)。

## 要求
<a name="api-multipart-abort-upload-requests"></a>

若要停止分段上傳，請將 HTTP `DELETE` 請求傳送至保存庫 `multipart-uploads` 子資源的 URI，並將特定的分段上傳 ID 識別為 URI 的一部分。

### 語法
<a name="api-multipart-abort-upload-requests-syntax"></a>

```
1. DELETE /AccountId/vaults/VaultName/multipart-uploads/uploadID HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-multipart-abort-upload-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-multipart-abort-upload-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-multipart-abort-upload-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-multipart-abort-upload-responses"></a>

### 語法
<a name="api-multipart-abort-upload-responses-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-multipart-abort-upload-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-multipart-abort-upload-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-multipart-abort-upload-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-multipart-abort-upload-examples"></a>

### 範例請求
<a name="api-multipart-abort-upload-example-request"></a>

在下列範例中，將 `DELETE` 請求傳送到分段上傳 ID 資源的 URI。

```
1. DELETE /-/vaults/examplevault/multipart-uploads/OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE  HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-multipart-abort-upload-example-response"></a>

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
```

## 相關章節
<a name="related-sections-multipart-abort-upload"></a>

 
+ [啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md)
+ [分段上傳 (PUT uploadID)](api-upload-part.md)
+ [完成分段上傳 (POST uploadID)](api-multipart-complete-upload.md)
+ [列出分段上傳 (GET 分段 - 上傳)](api-multipart-list-uploads.md)
+ [清單部分 (GET uploadID)](api-multipart-list-parts.md)
+ [上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 完成分段上傳 (POST uploadID)
<a name="api-multipart-complete-upload"></a>

## 說明
<a name="api-multipart-complete-upload-description"></a>

您呼叫此分段上傳操作，以通知 Amazon Glacier (Amazon Glacier) 所有封存組件都已上傳，Amazon Glacier 現在可從上傳的組件組合封存。

如需有關分段上傳的資訊，請參閱[上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)。

將封存合併並儲存到保存庫之後，Amazon Glacier 會傳回新建立的封存資源的封存 ID。上傳封存後，應該儲存傳回的封存 ID 以便稍後擷取封存。

在請求中，必須包括已上傳的整個封存的計算 SHA256 樹雜湊。如需有關運算 SHA256 樹雜湊的資訊，請參閱 [運算檢查總和](checksum-calculations.md)。在伺服器端，Amazon Glacier 也會建構組合封存的 SHA256 樹雜湊。如果值相符，Amazon Glacier 會將封存儲存至保存庫；否則會傳回錯誤，且操作會失敗。此 [清單部分 (GET uploadID)](api-multipart-list-parts.md) 操作會傳回為特定的分段上傳所上傳的組件清單。其中包含每個上傳部分的檢查總和資訊，可用於偵測錯誤的檢查總和問題。

此外，Amazon Glacier 也會檢查是否有任何遺漏的內容範圍。上傳部分時，可指定範圍值，以識別每個部分所適合在該封存中的最終整合位置。組合最終封存時，Amazon Glacier 會檢查是否有任何遺失的內容範圍，以及是否有任何遺失的內容範圍，Amazon Glacier 會傳回錯誤，且完成分段上傳操作會失敗。

完整分段上傳是等冪操作。在您首次成功完整分段上傳後，如果在短時間內再次呼叫該操作，該操作將成功並傳回相同的封存 ID。這在遇到網路問題或收到 500 伺服器錯誤時非常有用，在這種情況下，您可以重複完整分段上傳請求，並在不建立重複封存的情況下獲得相同的封存 ID。但是請注意，在分段上傳完成後，您無法呼叫清單組件操作，並且分段上傳不會出現在清單分段上傳回應中，即使冪等完整也是如此。

## 請求
<a name="api-multipart-complete-upload-requests"></a>

若要完成分段上傳，請將 HTTP POST 請求傳送至 Amazon Glacier 為回應啟動分段上傳請求而建立的上傳 ID URI。這與上傳組件時使用的 URI 相同。除了常見的必要標頭外，還必須包括整個封存的 SHA256 樹雜湊結果和封存的總大小 (以位元組為單位)。

### 語法
<a name="api-multipart-complete-upload-requests-syntax"></a>

```
1. POST /AccountId/vaults/VaultName/multipart-uploads/uploadID
2. Host: glacier.Region.amazonaws.com
3. Date: date
4. Authorization: SignatureValue
5. x-amz-sha256-tree-hash: SHA256 tree hash of the archive
6. x-amz-archive-size: ArchiveSize in bytes
7. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-multipart-complete-upload-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-multipart-complete-upload-requests-headers"></a>

除了所有作業通用的請求標頭之外，此作業還會使用下列請求標頭。如需常見請求標頭的資訊，請參閱[常見請求標題](api-common-request-headers.md)。


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
| x-amz-archive-size   |  整個封存的總大小 (以位元組為單位)。這個值應該是您上傳的個別組件的所有大小的總和。 類型：字串 預設：無 限制條件：無  |  是 | 
|  x-amz-sha256-tree-hash​  |  整個封存的 SHA256 樹雜湊。它是個別組件的 SHA256 樹雜湊的樹雜湊。如果您在請求中指定的值不符合 Amazon Glacier 計算的最終組合封存的 SHA256 樹雜湊，Amazon Glacier 會傳回錯誤，且請求會失敗。 類型：字串 預設：無 限制條件：無  |  是 | 

### 要求元素
<a name="api-multipart-complete-upload-requests-elements"></a>

此操作不使用請求元素。

## 回應
<a name="api-multipart-complete-upload-responses"></a>

Amazon Glacier (Amazon Glacier) 會建立整個封存的 SHA256 樹雜湊。如果值符合您在請求中指定之整個封存的 SHA256 樹雜湊，Amazon Glacier 會將封存新增至保存庫。在回應中，會傳回具有新增的封存資源的 URL 路徑的 HTTP `Location` 標頭。如果您在請求中傳送的封存大小或 SHA256 不相符，Amazon Glacier 將傳回錯誤，且上傳仍處於未完成狀態。稍後可以使用正確的值重試完整分段上傳操作，此時您可以成功建立封存。如果分段上傳未完成，最終 Amazon Glacier 將回收上傳 ID。

### 語法
<a name="api-multipart-complete-upload-responses-syntax"></a>

```
HTTP/1.1 201 Created
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Location: Location
x-amz-archive-id: ArchiveId
```

### 回應標頭
<a name="api-multipart-complete-upload-responses-headers"></a>

成功的回應除了所有作業通用的回應標頭之外，還包含下列回應標頭。如需常見回應標頭的詳細資訊，請參閱[常見回應標頭](api-common-response-headers.md)。


|  名稱  |  描述  | 
| --- | --- | 
|  Location  |  新建立的封存的相對 URI 路徑。此 URL 包含 Amazon Glacier 產生的封存 ID。 類型：字串  | 
|  x-amz-archive-id  |  此封存的 ID。此值也包含在 `Location` 標頭中。 類型：字串  | 

### 回應欄位
<a name="api-multipart-complete-upload-responses-elements"></a>

此作業不會傳回任何回應內文。

## 範例
<a name="api-multipart-complete-upload-examples"></a>

### 範例請求
<a name="api-multipart-complete-upload-example-request"></a>

在這個範例中，HTTP POST 請求被傳送到由初始分段上傳請求傳回的 URI。該請求同時指定整個封存的 SHA256 樹雜湊和總封存大小。

```
1. POST /-/vaults/examplevault/multipart-uploads/OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. z-amz-Date: 20170210T120000Z
4. x-amz-sha256-tree-hash:1ffc0f54dd5fdd66b62da70d25edacd0
5. x-amz-archive-size:8388608
6. x-amz-glacier-version: 2012-06-01
7. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-multipart-complete-upload-example-response"></a>

下列範例回應顯示 Amazon Glacier 已成功從您上傳的部分建立封存。該回應包含具有完整路徑的封存 ID。

```
1. HTTP/1.1 201 Created
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
4. Location: /111122223333/vaults/examplevault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId
5. x-amz-archive-id: NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId
```

您現在可以將 HTTP 請求傳送到新增的資源/封存的 URI。例如，您可以傳送 GET 請求以擷取封存。

## 相關章節
<a name="related-sections-complete-mpu"></a>

 
+ [啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md)
+ [分段上傳 (PUT uploadID)](api-upload-part.md)
+ [中止分段上傳 (DELETE uploadID)](api-multipart-abort-upload.md)
+ [列出分段上傳 (GET 分段 - 上傳)](api-multipart-list-uploads.md)
+ [清單部分 (GET uploadID)](api-multipart-list-parts.md)
+ [上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)
+  [刪除封存 (DELETE archive)](api-archive-delete.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 啟動分段上傳 (POST 分段 - 上傳)
<a name="api-multipart-initiate-upload"></a>

## Description
<a name="api-multipart-initiate-upload-description"></a>

這個作業會啟動分段上傳 (請參閱[上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md))。Amazon Glacier (Amazon Glacier) 會建立分段上傳資源，並在回應中傳回其 ID。在後續分段上傳操作中使用此上傳 ID。

當您啟動分段上傳時，可以指定部分大小 (以位元組為單位)。部分大小必須是 1 MiB (1024 KiB) 乘以 2 的次方，例如 1048576 (1 MiB)、2097152 (2 MiB)、4194304 (4 MiB)、8388608 (8 MiB) 等。最小允許部分大小為 1 MiB，最大為 4 GiB。

使用此上傳 ID上傳的每個部分（除最後一個外）都必須具有相同的大小。最後一個可以是相同的大小或較小。例如，假設您想要上傳 16.2 MiB 的檔案。如果您以 4 MiB 的部分大小啟動分段上傳，則將上傳四個部分的 4 MiB 和一個部分的 0.2 MiB。

 

**注意**  
當您開始分段上傳時，不需要知道封存的大小，因為 Amazon Glacier 不需要您指定整體封存大小。

完成分段上傳後，Amazon Glacier 會移除 ID 參考的分段上傳資源。如果您取消分段上傳，或者如果 24 小時內沒有活動，Amazon Glacier 也會移除分段上傳資源。該 ID 可能在24 小時後後仍然可用，但應用程式不應預期這種行為。

## 要求
<a name="api-multipart-initiate-upload-requests"></a>

若要啟動分段上傳，您可以將 HTTP `POST` 請求傳送到要儲存封存的保存庫的 `multipart-uploads` 子資源的 URI。請求必須包括部分大小，並且可以選擇包含封存的說明。

### 語法
<a name="api-multipart-initiate-upload-requests-syntax"></a>

```
1. POST /AccountId/vaults/VaultName/multipart-uploads 
2. Host: glacier.us-west-2.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
6. x-amz-archive-description: ArchiveDescription
7. x-amz-part-size: PartSize
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-archive-post-requests-parameters1"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-archive-post-requests-headers1"></a>

除了所有作業通用的請求標頭之外，此作業還會使用下列請求標頭。如需常見請求標頭的資訊，請參閱[常見請求標題](api-common-request-headers.md)。


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
|  x-amz-part-size  |  除了最後一個外，每個部分的大小 (以位元組為單位)。最後一個部分可以小於此部分大小。 類型：字串 預設：無 限制：部分大小必須是 1 MiB (1024 KiB) 乘以 2 的次方，例如 1048576 (1 MiB)、2097152 (2 MiB)、4194304 (4 MiB)、8388608 (8 MiB) 等。最小允許部分大小為 1 MiB，最大為 4 GiB (4096 MiB)。  |  是 | 
| x-amz-archive-description  |  封存描述您正在上傳的部分。它可以是純語言描述或您選擇指派的某個唯一識別符。當您擷取保存庫庫存 (請參閱 [啟動任務 (POST 任務)](api-initiate-job-post.md)) 時，庫存將為其傳回的每個封存的描述包括在內。封存描述中的前方空格會遭到移除。 類型：字串 預設：無 限制：描述必須小於或等於 1,024 位元組。允許的字元是沒有控制代碼的 7 位元 ASCII，尤其 ASCII 值是 32-126 十進制或 0x20-0x7E 十六進制。  |  否  | 

### 請求主體
<a name="api-multipart-initiate-upload-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-multipart-initiate-upload-responses"></a>

在回應中，Amazon Glacier 會建立由 ID 識別的分段上傳資源，並傳回分段上傳 ID 的相對 URI 路徑。

### 語法
<a name="api-multipart-initiate-upload-response-syntax"></a>

```
1. HTTP/1.1 201 Created
2. x-amzn-RequestId: x-amzn-RequestId
3. Date: Date
4. Location: Location
5. x-amz-multipart-upload-id: multiPartUploadId
```

### 回應標頭
<a name="api-archive-post-responses-headers2"></a>

成功的回應除了所有作業通用的回應標頭之外，還包含下列回應標頭。如需常見回應標頭的詳細資訊，請參閱[常見回應標頭](api-common-response-headers.md)。


|  名稱  |  描述  | 
| --- | --- | 
|  Location  |  已建立分段上傳 ID Amazon Glacier 的相對 URI 路徑。您使用此 URI 路徑來限制您的請求以上傳部分，並完成分段上傳。 類型：字串  | 
|  x-amz-multipart-upload-id  |  分段上傳的 ID。此值也包含在 `Location` 標頭中。 類型：字串  | 

### 回應內文
<a name="api-archive-post-responses-elements1"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-archive-post-responses-errors1"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="initiate-mpu-api-example"></a>

### 範例請求
<a name="api-multipart-initiate-upload-example-request"></a>

以下範例透過名為 `POST` 的保存庫的 `multipart-uploads` 子資源的 URI 傳送 HTTP `examplevault` 請求來啟動分段上傳。該請求包括標頭以指定 4 MiB (4194304 位元組) 的部分大小和選填的封存描述。

```
1. POST /-/vaults/examplevault/multipart-uploads 
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-archive-description: MyArchive-101
5. x-amz-part-size: 4194304
6. x-amz-glacier-version: 2012-06-01
7. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-multipart-initiate-upload-example-response"></a>

Amazon Glacier 會建立分段上傳資源，並將其新增至保存庫的`multipart-uploads`子資源。`Location` 回應標頭包括分段上傳 ID 的相對 URI 路徑。

```
1. HTTP/1.1 201 Created
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
4. Location: /111122223333/vaults/examplevault/multipart-uploads/OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE
5. x-amz-multipart-upload-id: OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE
```

如需上傳單個部分的詳細資訊，請參閱 [分段上傳 (PUT uploadID)](api-upload-part.md)。

## 相關章節
<a name="related-sections-initiate-mpu"></a>

 
+ [分段上傳 (PUT uploadID)](api-upload-part.md)
+ [完成分段上傳 (POST uploadID)](api-multipart-complete-upload.md)
+ [中止分段上傳 (DELETE uploadID)](api-multipart-abort-upload.md)
+ [列出分段上傳 (GET 分段 - 上傳)](api-multipart-list-uploads.md)
+ [清單部分 (GET uploadID)](api-multipart-list-parts.md)
+ [刪除封存 (DELETE archive)](api-archive-delete.md)
+ [上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 清單部分 (GET uploadID)
<a name="api-multipart-list-parts"></a>

## Description
<a name="api-multipart-list-partsDescription"></a>

此分段上傳操作列出已上傳到由上傳 ID 識別的特定分段上傳中的封存部分。如需有關分段上傳的資訊，請參閱[上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)。

在完成分段上傳之前，您可以在正在進行的分段上傳期間隨時提出此請求。Amazon Glacier 會傳回按您在每個部分上傳中指定的範圍排序的部分清單。如果您在完成分段上傳後傳送列出組件請求，Amazon Glacier (Amazon Glacier) 會傳回錯誤。

此清單部分操作支援分頁。您應該經常檢查回應內文 `Marker` 欄位中註明可繼續列表的標記，如果沒有其他項目，`marker` 欄位為 `null`。如果 `marker` 不是 null，若要擷取您傳送的另一組列出組件請求，並將`marker`請求參數設定為 Amazon Glacier 傳回的標記值，以回應先前的列出組件請求。

您可以透過在請求中指定 `limit` 參數來限制回應中傳回的部分數量。

## 要求
<a name="api-multipart-list-parts-requests"></a>

### 語法
<a name="api-multipart-list-parts-requests-syntax"></a>

要列出正在進行的分段上傳的部分，請將 `GET` 請求傳送到分段上傳 ID 資源的 URI。當您啟動分段上傳時，將傳回分段上傳 ID ([啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md))。您可以選擇指定 `marker` 和 `limit` 參數。

```
1. GET /AccountId/vaults/VaultName/multipart-uploads/uploadID HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-multipart-list-parts-requests-parameters"></a>


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
| limit  |  所要傳回的部分數量上限。預設限制為 50。傳回的部分數量可能少於指定的限制，但傳回的部分數量永遠不會超過限制。 類型：字串 限制：最小整數值為 `1`。最大整數值為 `50`。  |  否  | 
|  marker  |  用於分頁的不透明字串。`marker` 指定部分清單應開始的部分。從之前的清單部分回應的回應中獲取 `marker` 值。如果您要繼續對之前的清單部分請求中開始的結果進行分頁，則只需包含 `marker`。 類型：字串 限制條件：無  |  否 | 

### 請求標頭
<a name="api-multipart-list-parts-requests-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 請求主體
<a name="api-multipart-list-parts-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-multipart-list-parts-responses"></a>

### 語法
<a name="api-multipart-list-parts-responses-syntax"></a>

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: x-amzn-RequestId
 3. Date: Date
 4. Content-Type: application/json
 5. Content-Length: Length
 6. 
 7. {
 8.     "ArchiveDescription" : String,
 9.     "CreationDate" : String,
10.     "Marker": String,
11.     "MultipartUploadId" : String,
12.     "PartSizeInBytes" : Number,
13.     "Parts" : 
14.     [ {
15.       "RangeInBytes" : String,
16.       "SHA256TreeHash" : String
17.       },
18.       ...
19.      ],
20.     "VaultARN" : String
21. }
```

### 回應標頭
<a name="api-multipart-list-parts-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-multipart-list-parts-responses-elements"></a>

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

**ArchiveDescription**  
在啟動分段上傳請求中指定的封存說明。如果在啟動分段上傳操作中未指定封存說明，則此欄位為 `null`。  
*類型：*字串

**CreationDate**  
啟動分段上傳的 UTC 時間。  
*類型*：字串 ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**Marker**  
一個不透明字串，表示繼續結果分頁之處。您可以在新的清單部分請求中使用 `marker` 來取得清單中的更多任務。如果沒有更多的部分列出，則此值為 `null`。  
*類型：*字串

**MultipartUploadId**  
與部分關聯的上傳的 ID。  
*類型：*字串

**PartSizeInBytes**  
部分大小 (以位元組為單位)。這與您在啟動分段上傳請求中指定的值相同。  
*類型*：數字

**部分**  
分段上傳的部分大小清單。陣列中的每個物件都包含 `RangeBytes` 和 `sha256-tree-hash` 名稱/值對。  
*類型*：陣列

**RangeInBytes**  
部分的位元組範圍，包含範圍的上限值。  
*類型：*字串

**SHA256TreeHash**   
Amazon Glacier 為組件計算的 SHA256 樹雜湊值。此欄位永遠不為 `null`。  
*類型：*字串

**VaultARN**  
啟動分段上傳的文件庫的 Amazon Resource Name (ARN)。  
*類型：*字串

### 錯誤
<a name="api-multipart-list-parts-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-multipart-list-parts-examples"></a>

### 範例：列出分段上傳的部分
<a name="api-multipart-list-parts-examples-one"></a>

以下範例列出了上傳的所有部分。此範例將 HTTP `GET` 請求傳送到正在進行的分段上傳的特定分段上傳 ID 的 URI，最多可傳回 1,000 個部分。

#### 範例請求
<a name="api-multipart-list-parts-example-request"></a>

```
1. GET /-/vaults/examplevault/multipart-uploads/OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-multipart-list-parts-example-response"></a>

在回應中，Amazon Glacier 會傳回與指定分段上傳 ID 相關聯的上傳組件清單。在這個範例中，只有兩個部分。傳回的 `Marker` 欄位是 `null`，表示沒有更多部分的分段上傳。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 412
 6.       
 7. {
 8.     "ArchiveDescription" : "archive description",
 9.     "CreationDate" : "2012-03-20T17:03:43.221Z",
10.     "Marker": null,
11.     "MultipartUploadId" : "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
12.     "PartSizeInBytes" : 4194304,
13.     "Parts" : 
14.     [ {
15.       "RangeInBytes" : "0-4194303",
16.       "SHA256TreeHash" : "01d34dabf7be316472c93b1ef80721f5d4"
17.       },
18.       {
19.       "RangeInBytes" : "4194304-8388607",
20.       "SHA256TreeHash" : "0195875365afda349fc21c84c099987164"
21.       }],
22.     "VaultARN" : "arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault"
23. }
```

### 範例：列出分段上傳的部分 (指定標記和限制請求參數)
<a name="api-multipart-list-parts-examples-two"></a>

以下範例示範如何使用分頁來取得有限數量的結果。此範例將 HTTP `GET` 請求傳送到正在進行的分段上傳的特定分段上傳 ID 的 URI，以傳回一部分。起始 `marker` 參數指定在哪些部分上啟動部分清單。您可以從對部分清單的上一個請求的回應中獲取 `marker` 值。此外，在這個範例中，`limit` 參數設為 1 和傳回一個部分。請注意，`Marker` 欄位不是 `null`，表示至少還有一個要獲取的部分。

#### 範例請求
<a name="api-multipart-list-parts-example-request-two"></a>

```
1. GET /-/vaults/examplevault/multipart-uploads/OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE?marker=1001&limit=1 HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-multipart-list-parts-example-response-two"></a>

在回應中，Amazon Glacier 會傳回與指定的進行中分段上傳 ID 相關聯的上傳組件清單。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: text/json
 5. Content-Length: 412
 6.       
 7. {
 8.     "ArchiveDescription" : "archive description 1",
 9.     "CreationDate" : "2012-03-20T17:03:43.221Z",
10.     "Marker": "MfgsKHVjbQ6EldVl72bn3_n5h2TaGZQUO-Qb3B9j3TITf7WajQ",
11.     "MultipartUploadId" : "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
12.     "PartSizeInBytes" : 4194304,
13.     "Parts" : 
14.     [ {
15.       "RangeInBytes" : "4194304-8388607",
16.       "SHA256TreeHash" : "01d34dabf7be316472c93b1ef80721f5d4"
17.       }],
18.     "VaultARN" : "arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault"
19. }
```

## 相關章節
<a name="related-sections-api-multipart-list-parts"></a>

 
+ [啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md)
+ [分段上傳 (PUT uploadID)](api-upload-part.md)
+ [完成分段上傳 (POST uploadID)](api-multipart-complete-upload.md)
+ [中止分段上傳 (DELETE uploadID)](api-multipart-abort-upload.md)
+ [列出分段上傳 (GET 分段 - 上傳)](api-multipart-list-uploads.md)
+ [上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 列出分段上傳 (GET 分段 - 上傳)
<a name="api-multipart-list-uploads"></a>

## Description
<a name="api-multipart-list-uploads-description"></a>

這個分段上傳操作列出了用於指定的文件庫的進行中分段上傳。進行中的分段上傳是已由 [啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md) 請求啟動，但尚未完成或停止的分段上傳。「列出分段上傳」回應中傳回的清單中，並沒有保證順序。

「列出分段上傳」操作支援分頁。在預設情況下，在回應中這項操作會傳回最多 50 個分段上傳。您應該經常檢查回應內文 `marker` 欄位中註明可繼續列表的標記，如果沒有其他項目，`marker` 欄位為 `null`。

如果 `marker` 不是 null，若要擷取下一組分段上傳，請傳送另一個「列出分段上傳」請求，並將 `marker` 請求參數設定為 Amazon Glacier (Amazon Glacier) 傳回的標記值，以回應先前的「列出分段上傳」請求。

請注意這個操作和 [清單部分 (GET uploadID)](api-multipart-list-parts.md) 操作之間的不同。「列出分段上傳」操作列出了文件庫的所有分段上傳。「列出分段」操作會傳回上傳 ID 識別之特定分段上傳部分。

如需有關分段上傳的資訊，請參閱[上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)。

## 要求
<a name="api-multipart-list-uploads-requests"></a>

### 語法
<a name="api-multipart-list-uploads-requests-syntax"></a>

若要列出段上傳，可將 `GET` 請求傳送到文件庫的 `multipart-uploads` 子資源的 URI。您可以選擇指定 `marker` 和 `limit` 參數。

```
1. GET /AccountId/vaults/VaultName/multipart-uploads HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-multipart-list-uploads-requests-parameters"></a>


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
|  limit  |  指定回應內文中傳回的上傳數量上限。如果未指定，「列出上傳」操作會傳回最多 50 個上傳。 類型：字串 限制：最小整數值為 `1`。最大整數值為 `50`。  |  否 | 
| marker  |  用於分頁的不透明字串。`marker` 指定上傳清單應開始的上傳部分。從之前的「列出上傳」回應中取得 `marker` 值。如果您要繼續對之前的「列出上傳」請求中開始的結果進行分頁，則只需包含 `marker`。 類型：字串 限制條件：無  |  否  | 

### 請求標頭
<a name="api-multipart-list-uploads-requests-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 請求主體
<a name="api-multipart-list-uploads-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-multipart-list-uploads-responses"></a>

### 語法
<a name="api-multipart-list-uploads-responses-syntax"></a>

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: x-amzn-RequestId
 3. Date: Date
 4. Content-Type: application/json
 5. Content-Length: Length
 6. 
 7. {
 8.   "Marker": String,
 9.   "UploadsList" : [ 
10.     {
11.       "ArchiveDescription": String,
12.       "CreationDate": String,
13.       "MultipartUploadId": String,
14.       "PartSizeInBytes": Number,
15.       "VaultARN": String
16.     }, 
17.    ...
18.   ]
19. }
```

### 回應標頭
<a name="api-multipart-list-uploads-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-multipart-list-uploads-responses-elements"></a>

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

**ArchiveDescription**  
在啟動分段上傳請求中指定的封存說明。如果在啟動分段上傳操作中未指定封存說明，則此欄位為 `null`。  
*類型：*字串

**CreationDate**  
啟動分段上傳的 UTC 時間。  
*類型*：字串 ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**Marker**  
一個不透明字串，表示繼續結果分頁之處。您在新的「列出分段上傳」請求中使用 `marker` 來取得清單中的更多上傳。如果沒有更多的上傳，則此值為 `null`。  
*類型：*字串

**PartSizeInBytes**  
[啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md) 請求中指定的分段大小。這是在上傳的所有部分的大小，除了最後一個分段外，其可能小於此大小。  
*類型*：數字

**MultipartUploadId**  
分段上傳的 ID。  
*類型：*字串

**UploadsList **  
關於分段上傳物件的中繼資料清單。清單中的每一個項目包含一組用於對應上傳的名稱值的配對，包括 `ArchiveDescription` `CreationDate`、`MultipartUploadId`、`PartSizeInBytes` 和 `VaultARN`。  
*類型*：陣列

**VaultARN**  
文件庫的 Amazon Resource Name (ARN)，其中包含存檔。  
*類型：*字串

### 錯誤
<a name="api-multipart-list-uploads-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-multipart-list-uploads-examples"></a>

### 範例：列出所有分段上傳
<a name="api-multipart-list-uploads-examples-one"></a>

以下範例列出文件庫所有進行中的分段上傳。範例對指定之文件庫的 `GET` 子資源的 URI 顯示 HTTP `multipart-uploads` 請求。由於在請求中未指定 `marker` 和 `limit` 參數，因此傳回最多 1,000 個進行中分段上傳。

#### 範例請求
<a name="api-multipart-list-uploads-example-request"></a>

```
1. GET /-/vaults/examplevault/multipart-uploads HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-multipart-list-uploads-example-response"></a>

在回應中，Amazon Glacier 會傳回指定保存庫的所有進行中分段上傳的清單。`marker` 欄位為 `null`，其表示沒有其他上傳可列出。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 1054
 6.       
 7. {
 8.   "Marker": null, 
 9.   "UploadsList": [ 
10.     {
11.       "ArchiveDescription": "archive 1",
12.       "CreationDate": "2012-03-19T23:20:59.130Z",
13.       "MultipartUploadId": "xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev",
14.       "PartSizeInBytes": 4194304,
15.       "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
16.     }, 
17.     {
18.       "ArchiveDescription": "archive 2",
19.       "CreationDate": "2012-04-01T15:00:00.000Z",
20.       "MultipartUploadId": "nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc",
21.       "PartSizeInBytes": 4194304,
22.       "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
23.     },
24.     {
25.       "ArchiveDescription": "archive 3",
26.       "CreationDate": "2012-03-20T17:03:43.221Z",
27.       "MultipartUploadId": "qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV",
28.       "PartSizeInBytes": 4194304,
29.       "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
30.     } 
31.   ]
32. }
```

### 範例：部分列出分段上傳
<a name="api-multipart-list-uploads-examples-two"></a>

以下範例示範如何使用分頁來取得有限數量的結果。範例對指定之文件庫的 `GET` 子資源的 URI 顯示 HTTP `multipart-uploads` 請求。在這個範例中，`limit` 參數設為 1，其表示只傳回清單中一個上傳，而 `marker` 參數指出傳回清單開始進行的分段上傳 ID。

#### 範例請求
<a name="api-multipart-list-uploads-example-request-two"></a>

```
1. GET /-/vaults/examplevault/multipart-uploads?limit=1&marker=xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-multipart-list-uploads-example-response-two"></a>

在回應中，Amazon Glacier (Amazon Glacier) 會傳回指定保存庫不超過兩個進行中分段上傳的清單，從指定的標記開始，並傳回兩個結果。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 470
 6. 
 7. {
 8.   "Marker": "qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV",
 9.   "UploadsList" : [ 
10.     {
11.       "ArchiveDescription": "archive 2",
12.       "CreationDate": "2012-04-01T15:00:00.000Z",
13.       "MultipartUploadId": "nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc",
14.       "PartSizeInBytes": 4194304,
15.       "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
16.     }
17.   ]
18. }
```

## 相關章節
<a name="related-sections-multipart-list-uploads"></a>

 
+ [啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md)
+ [分段上傳 (PUT uploadID)](api-upload-part.md)
+ [完成分段上傳 (POST uploadID)](api-multipart-complete-upload.md)
+ [中止分段上傳 (DELETE uploadID)](api-multipart-abort-upload.md)
+ [清單部分 (GET uploadID)](api-multipart-list-parts.md)
+ [上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 分段上傳 (PUT uploadID)
<a name="api-upload-part"></a>

## 說明
<a name="api-job-get-description"></a>

這個分段上傳操作會上傳封存的一部分。您可以任何順序上傳封存部分，因為在您的分段上傳請求中您指定將在部分中上傳之整合封存的位元組範圍。您也可以平行上傳這些部分。您可以上傳多達 10,000 個部分的分段上傳。

如需有關分段上傳的資訊，請參閱[上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)。

 

如果以下任何條件成立，Amazon Glacier (Amazon Glacier) 會拒絕您的上傳組件請求：

 
+ **SHA256 樹雜湊不相符：**為確保部分資料不會在傳輸時毀損，您運算該部分的 SHA256 樹雜湊並將其包含在請求中。收到組件資料時，Amazon Glacier 也會計算 SHA256 樹雜湊。如果兩個雜湊值不相符，操作就會失敗。如需有關運算 SHA256 樹雜湊的資訊，請參閱 [運算檢查總和](checksum-calculations.md)。
+ **SHA256 線性雜湊不相符：**由於授權需要，您運算整個上傳承載的 SHA256 線性雜湊，並將其包含在請求中。如需有關運算 SHA256 線性雜湊的資訊，請參閱[運算檢查總和](checksum-calculations.md)。
+ **部分大小不相符：**每個部分 (最後部分除外) 的大小，必須符合在對應的 [啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md) 請求中所指定的大小。最後分段的大小必須與指定的大小相同或小於指定的大小。
**注意**  
如果您所上傳分段的大小小於在起始分段上傳請求中所指定的分段大小，而且該分段不是最後一個分段，則上傳分段請求將會成功。不過，後續的「完成分段上傳」請求將會失敗。
+ **範圍不符合：**請求中的位元組範圍值，不符合對應的起始請求中所指定的部分大小。例如，如果您指定 4194304 位元組 (4 MB) 的分段大小，則 0 到 4194303 位元組 (4 MB -1) 和 4194304 (4 MB) 到 8388607 (8 MB -1) 是有效的分段範圍。不過，如果您設定範圍值為 2 MB 到 6 MB，範圍就不符合分段大小且上傳將會失敗。

此為等冪操作。如果您多次上傳相同的分段，最新請求中所包含的資料會覆寫之前上傳的資料。

## 請求
<a name="api-job-get-requests"></a>

您傳送此 HTTP `PUT` 請求至由您起始分段上傳請求所傳回的上傳 ID 的 URI。Amazon Glacier 使用上傳 ID 將分段上傳與特定分段上傳建立關聯。請求必須包含分段資料的 SHA256 樹雜湊 (`x-amz-SHA256-tree-hash` 標頭)、整個承載的 SHA256 線性雜湊 (`x-amz-content-sha256` 標頭)、位元組範圍 (`Content-Range` 標頭)，以及以位元組表示的分段長度 (`Content-Length` 標頭)。

### 語法
<a name="api-job-get-requests-syntax"></a>

```
 1. PUT /AccountId/vaults/VaultName/multipart-uploads/uploadID HTTP/1.1
 2. Host: glacier.Region.amazonaws.com
 3. Date: Date
 4. Authorization: SignatureValue
 5. Content-Range: ContentRange
 6. Content-Length: PayloadSize
 7. Content-Type: application/octet-stream
 8. x-amz-sha256-tree-hash: Checksum of the part
 9. x-amz-content-sha256: Checksum of the entire payload			
10. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-upload-part-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-upload-part-requests-headers"></a>

除了所有作業通用的請求標頭之外，此作業還會使用下列請求標頭。如需常見請求標頭的資訊，請參閱[常見請求標題](api-common-request-headers.md)。


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
| Content-Length  |  識別以位元組表示的分段長度。 類型：字串 預設：無 限制條件：無  |  否 | 
| Content-Range  |  識別在此分段將上傳之整合封存的位元組範圍。Amazon Glacier 會使用此資訊以適當的順序組合封存。此標頭的格式遵循 [ RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16)。範例標頭為 `Content-Range:bytes 0-4194303/*`。 類型：字串 預設：無 限制條件：範圍不得大於您在起始分段上傳時所指定的分段大小。  |  是 | 
|  x-amz-content-sha256  |  所上傳承載的 SHA256 檢查總和 (線性雜湊)。這與您在 `x-amz-sha256-tree-hash` 標頭中指定的值不同。 類型：字串 預設：無 限制條件：無  |  是 | 
|  x-amz-sha256-tree-hash​  |  指定將上傳之資料的 SHA256 樹雜湊。如需有關運算 SHA256 樹雜湊的資訊，請參閱 [運算檢查總和](checksum-calculations.md)。 類型：字串 預設：無 限制條件：無  |  是 | 

### 請求主體
<a name="api-job-get-requests-elements"></a>

 請求內文包含要上傳的資料。

## 回應
<a name="api-job-get-responses"></a>

成功上傳組件後，Amazon Glacier 會傳回`204 No Content`回應。

### 語法
<a name="api-job-get-response-syntax"></a>

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: x-amzn-RequestId
3. Date: Date
4. x-amz-sha256-tree-hash: ChecksumComputedByAmazonGlacier
```

### 回應標頭
<a name="api-job-get-responses-headers"></a>

成功的回應除了所有作業通用的回應標頭之外，還包含下列回應標頭。如需常見回應標頭的詳細資訊，請參閱[常見回應標頭](api-common-response-headers.md)。


|  名稱  |  描述  | 
| --- | --- | 
|  x-amz-sha256-tree-hash​  |  Amazon Glacier 為上傳部分計算的 SHA256 樹雜湊。 類型：字串  | 

### 回應內文
<a name="api-job-get-responses-elements"></a>

此作業不會傳回任何回應內文。

## 範例
<a name="api-job-get-examples"></a>

以下請求上傳 4 MB 的分段。請求會設定位元組範圍以將此成為封存的第一個分段。

### 範例請求
<a name="api-job-get-examples-sample-request"></a>

範例傳送 HTTP `PUT` 請求以上傳 4 MB 的分段。請求是傳送至由起始分段上傳請求所傳回之上傳 ID 的 URI。`Content-Range` 標頭將分段識別為封存的第一個 4 MB 資料分段。

```
1. PUT /-/vaults/examplevault/multipart-uploads/OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
4. Content-Range:bytes 0-4194303/*
5. x-amz-sha256-tree-hash:c06f7cd4baacb087002a99a5f48bf953
6. x-amz-content-sha256:726e392cb4d09924dbad1cc0ba3b00c3643d03d14cb4b823e2f041cff612a628
7. Content-Length: 4194304
8. Authorization: Authorization=AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-content-sha256;x-amz-date;x-amz-glacier-version,Signature=16b9a9e220a37e32f2e7be196b4ebb87120ca7974038210199ac5982e792cace
```

若要上傳下一個分段，程序是相同的；不過，您必須計算要上傳分段的新 SHA256 樹雜湊，也可以指定新的位元組範圍，以指出分段將進入最終組件的哪裡。以下請求會上傳使用相同上傳 ID 的另一個分段。請求指定之前請求之後的下一個 4 MB 封存和 4 MB 的分段大小。

```
1. PUT /-/vaults/examplevault/multipart-uploads/OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
4. Content-Range:bytes 4194304-8388607/*
5. Content-Length: 4194304
6. x-amz-sha256-tree-hash:f10e02544d651e2c3ce90a4307427493
7. x-amz-content-sha256:726e392cb4d09924dbad1cc0ba3b00c3643d03d14cb4b823e2f041cff612a628
8. x-amz-glacier-version: 2012-06-01
9. Authorization: Authorization=AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120525/us-west-2/glacier/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date;x-amz-glacier-version, Signature=16b9a9e220a37e32f2e7be196b4ebb87120ca7974038210199ac5982e792cace
```

組件可以按任何順序上傳；Amazon Glacier 會使用每個組件的範圍規格來決定組合組件的順序。

### 回應範例
<a name="api-job-get-examples-sample-response"></a>

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. x-amz-sha256-tree-hash: c06f7cd4baacb087002a99a5f48bf953
4. Date: Wed, 10 Feb 2017 12:00:00 GMT
```

## 相關章節
<a name="related-sections-upload-part"></a>

 
+ [啟動分段上傳 (POST 分段 - 上傳)](api-multipart-initiate-upload.md)
+ [分段上傳 (PUT uploadID)](#api-upload-part)
+ [完成分段上傳 (POST uploadID)](api-multipart-complete-upload.md)
+ [中止分段上傳 (DELETE uploadID)](api-multipart-abort-upload.md)
+ [列出分段上傳 (GET 分段 - 上傳)](api-multipart-list-uploads.md)
+ [清單部分 (GET uploadID)](api-multipart-list-parts.md)
+ [上傳分段中的大型封存 (分段上傳)](uploading-archive-mpu.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 任務操作
<a name="job-operations"></a>

以下是 Amazon Glacier 中可用的任務操作。

**Topics**
+ [描述任務 (GET JobID)](api-describe-job-get.md)
+ [「取得任務輸出」 (GET 輸出)](api-job-output-get.md)
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)
+ [列出工作 (GET 工作)](api-jobs-get.md)

# 描述任務 (GET JobID)
<a name="api-describe-job-get"></a>

## Description
<a name="api-describe-job-get-description"></a>

此操作會傳回您先前啟動之任務的相關資訊，包括任務啟動日期、啟動任務的使用者、任務狀態碼/訊息，以及在 Amazon Glacier (Amazon SNS) 主題。 Amazon Glacier 如需有關啟動任務的詳細資訊，請參閱 [啟動任務 (POST 任務)](api-initiate-job-post.md)。

 

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

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

## 要求
<a name="api-describe-job-get-requests"></a>

### 語法
<a name="api-describe-job-get-requests-syntax"></a>

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

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

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

 

**注意**  
在請求中，如果您省略 `JobID`，該回應將傳回在指定文件庫上的所有作用中任務的清單。如需有關列出任務的詳細資訊，請參閱 [列出工作 (GET 工作)](api-jobs-get.md)。

### 請求參數
<a name="api-describe-job-get-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-describe-job-get-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-describe-job-get-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-describe-job-get-responses"></a>

### 語法
<a name="api-describe-job-get-response-syntax"></a>

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

### 回應標頭
<a name="api-describe-job-get-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-describe-job-get-responses-elements"></a>

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

**Action**  
工作類型。它是 `ArchiveRetrieval`、`InventoryRetrieval` 或 `Select`。  
*類型：*字串

**封存**  
針對選擇或封存擷取任務請求的封存 ID。否則，此欄位為 `null`。  
*類型：*字串

**ArchiveSHA256TreeHash**  
用於封存任務的整個封存的 SHA256 樹狀雜湊。對於庫存擷取作業，此欄位為 `null`。  
*類型：*字串

**ArchiveSizeInBytes**  
對於 `ArchiveRetrieval` 任務，這是請求下載的封存的大小，以位元組為單位。對於 `InventoryRetrieval` 任務，值為 `null`。  
*類型*：數字

**已完成**  
工作狀態。當封存或庫存擷取任務完成後，您可以使用 [「取得任務輸出」 (GET 輸出)](api-job-output-get.md) 獲取任務的輸出。  
*類型*：布林值

**CompletionDate**  
任務請求完成的國際標準時間 (UTC) 的時間。當任務正在進行時，該值為空。  
*類型：*字串

**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 任務)](api-initiate-job-post.md) 請求指定了樹狀雜湊值的範圍，則此欄位會傳回一個值。如需關於封存範圍擷取的樹狀雜湊值的詳細資訊，請參閱 [下載資料時接收檢查總和](checksum-calculations-range.md)。  
對於擷取整個封存的特定案例，此值與 `ArchiveSHA256TreeHash` 值相同。  
此欄位在以下情況下為 `null`：  
+ 封存擷取任務所指定的範圍不符合樹狀雜湊。
+ 指定與整個封存和任務狀態相等的範圍的封存任務是 `InProgress`。
+ 庫存任務
+ 選取任務。
*類型：*字串

**SNSTopic**  
接收通知的 Amazon SNS 主題。  
*類型：*字串

**StatusCode**  
表示任務狀態的代碼。  
*有效值*：`InProgress` \$1 `Succeeded` \$1 `Failed`  
*類型：*字串

**StatusMessage**  
描述任務狀態的友善訊息。  
*類型：*字串

**層**  
用於選擇或封存擷取的資料存方案。  
*有效值*：`Bulk` \$1 `Expedited` \$1 `Standard`  
*類型：*字串

**VaultARN**  
該任務是子資源的文件庫 Amazon Resource Name (ARN)。  
*類型：*字串

### 錯誤
<a name="api-describe-job-get-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-describe-job-get-examples"></a>

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

### 範例請求：取得任務描述
<a name="api-describe-job-get-example-request"></a>

```
1. GET /-/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-describe-job-get-example-response"></a>

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

 
+ `Action`欄位值為 `ArchiveRetrieval`。
+ `ArchiveSizeInBytes` 欄位會顯示在封存擷取作業中請求的封存大小。
+ `ArchiveSHA256TreeHash` 欄位顯示整個封存的 SHA256 樹狀雜湊。
+ `RetrievalByteRange` 欄位顯示在啟動任務請求中請求的範圍。在這個範例中，請求整個封存。
+ `SHA256TreeHash` 欄位顯示在啟動任務請求中請求的範圍的 SHA256 樹狀雜湊。在這個範例中，它與 `ArchiveSHA256TreeHash` 欄位相同，這表示請求整個封存。
+ 此 `InventorySizeInBytes` 欄位值為 `null`，因為它不適用於封存擷取任務。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 419
 6. {
 7.   "Action": "ArchiveRetrieval",
 8.   "ArchiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
 9.   "ArchiveSizeInBytes": 16777216,
10.   "ArchiveSHA256TreeHash": "beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60",
11.   "Completed": false,
12.   "CompletionDate": null,
13.   "CreationDate": "2012-05-15T17:21:39.339Z",
14.   "InventorySizeInBytes": null,
15.   "JobDescription": "My ArchiveRetrieval Job",
16.   "JobId": "HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
17.   "RetrievalByteRange": "0-16777215",
18.   "SHA256TreeHash": "beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60",
19.   "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic",
20.   "StatusCode": "InProgress",
21.   "StatusMessage": "Operation in progress.",
22.   "Tier": "Bulk",
23.   "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
24. }
```

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

 
+ `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"
    },   
}
```

## 相關章節
<a name="related-sections-describe-job-get"></a>

 
+ [「取得任務輸出」 (GET 輸出)](api-job-output-get.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 「取得任務輸出」 (GET 輸出)
<a name="api-job-output-get"></a>

## Description
<a name="api-job-output-get-description"></a>

此操作可下載使用 [啟動任務 (POST 任務)](api-initiate-job-post.md) 啟動的任務的輸出。根據您在啟動任務時所指定的任務類型，輸出將是存檔或文件庫清查的內容。

您可以透過指定位元組範圍來下載所有任務輸出或下載部分輸出。對於封存和庫存擷取任務，應根據**取得任務輸出**回應中的標題中傳回的大小來驗證下載的大小。

對於封存擷取任務，您還應該驗證大小是否符合預期。如果您下載部分輸出，則預期的大小取決於您指定的位元組範圍。例如，如果您指定 `bytes=0-1048575` 範圍，則應驗證下載大小為 1,048,576 位元組。如果您下載整個封存，預期的大小是上傳到 Amazon Glacier (Amazon Glacier) 時的封存大小。預期大小也會從**取得任務輸出**回應的標題中傳回。

如果是封存擷取任務，Amazon Glacier 會根據您指定的位元組範圍，傳回資料部分的檢查總和。為確保下載的部分是正確的資料，請計算用戶端上的檢查總和，驗證值是否符合，並驗證大小是否符合您所期望的。

在 Amazon Glacier 完成任務後至少 24 小時內，任務 ID 不會過期。也就是說，您可以在 Amazon Glacier 完成任務後的 24 小時內下載任務輸出。

## 要求
<a name="api-job-output-get-requests"></a>

### 語法
<a name="api-job-output-get-requests-syntax"></a>

若要擷取任務輸出，請將 HTTP `GET` 請求傳送到特定任務的 `output` 的 URI。

```
1. GET /AccountId/vaults/VaultName/jobs/JobID/output HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. Range: ByteRangeToRetrieve
6. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-job-output-get-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-job-output-get-requests-headers"></a>

除了所有作業通用的請求標頭之外，此作業還會使用下列請求標頭。如需常見請求標頭的資訊，請參閱[常見請求標題](api-common-request-headers.md)。


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
| Range  |  從輸出中擷取的位元組範圍。例如，如果想要下載第一個 1,048,576 位元組，請將範圍指定為 `bytes=0-1048575`。如需詳細資訊，請前往[範圍標頭欄位定義](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35)。範圍與啟動任務請求中指定的任何範圍有關。在預設情況下，這個操作下載整個輸出。 如果任務輸出很大，則您可以使用 `Range` 請求標頭來擷取輸出的一部分。這可讓您可以以較小的位元組區塊下載整個輸出。例如，假設您有 1 GB 的任務輸出要下載，並且您決定一次下載 128 MB 的資料區塊，總共有八個「取得任務輸出」請求。您將使用以下程序下載任務輸出： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/amazonglacier/latest/dev/api-job-output-get.html) 類型：字串 預設：無 限制條件：無  |  否  | 

### 請求主體
<a name="api-job-output-get-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-job-output-get-responses"></a>

### 語法
<a name="api-job-output-get-response-syntax"></a>

對於傳回所有任務資料的擷取請求，任務輸出回應將傳回 `200 OK` 回應程式碼。當請求部分內容時，例如，如果您在請求中指定了 `Range` 標頭，，則會傳回回應的程式碼 `206 Partial Content`。

```
1. HTTP/1.1 200 OK
2. x-amzn-RequestId: x-amzn-RequestId
3. Date: Date
4. Content-Type: ContentType
5. Content-Length: Length
6. x-amz-sha256-tree-hash: ChecksumComputedByAmazonGlacier
7. 
8. [Body containing job output.]
```

### 回應標頭
<a name="api-job-output-get-responses-headers"></a>


|  標頭  |  Description  | 
| --- | --- | 
| Content-Range  |  Amazon Glacier 傳回的位元組範圍。如果只下載部分輸出，回應會提供 Amazon Glacier 傳回的位元組範圍。 例如，`bytes 0-1048575/8388608` 從 8 MB中傳回第一個 1 MB。 如需有關 `Content-Range` 標頭的詳細資訊，請參閱[內容 - 範圍標頭欄位定義](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16)。 類型：字串  | 
| Content-Type  |  內容類型取決於任務輸出是存檔還是文件庫清查。  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/amazonglacier/latest/dev/api-job-output-get.html) 類型：字串  | 
| x-amz-sha256-tree-hash​ |  在回應中資料的檢查總和。只有在擷取封存擷取任務的輸出時才傳回此標頭。此外, 當啟動任務請求中請求的擷取資料範圍與樹狀雜湊符合，並且在「取得任務輸出」中下載的範圍也與樹狀雜湊符合時，會出現此標頭。如需有關樹狀雜湊符合範圍的詳細資訊，請參閱 [下載資料時接收檢查總和](checksum-calculations-range.md)。 例如，如果在啟動任務請求中指定了要擷取的樹狀雜湊符合範圍 (包括整個封存)，則在下列情況下，您將收到下載資料的檢查總和：  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/amazonglacier/latest/dev/api-job-output-get.html) 類型：字串  | 

### 回應內文
<a name="api-job-output-get-responses-elements"></a>

Amazon Glacier 會在回應內文中傳回任務輸出。根據任務類型，輸出可以是存檔內容或文件庫清查。在文件庫清查情況下，根據預設，會以下列 JSON 內文傳回清查清單。

 

```
 1. {
 2.  "VaultARN": String,
 3.  "InventoryDate": String,
 4.  "ArchiveList": [
 5.       {"ArchiveId": String,
 6.        "ArchiveDescription": String,
 7.        "CreationDate": String,
 8.        "Size": Number,
 9.        "SHA256TreeHash": String
10.       },
11.       ...
12.     ]
13. }
```

如果您在啟動文件庫清查任務時請求以逗號分隔值 (CSV) 輸出格式，則在內文中以 CSV 格式傳回文件庫清查。CSV 格式有五個欄「ArchiveId」、」 ArchiveDescription」、」 CreationDate」、「Size」和「SHA256TreeHash」，其定義與相應的 JSON 欄位相同。

**注意**  
在傳回的 CSV 格式中，欄位可能會以整個欄位用雙引號括起來。包含逗號或雙引號的欄位一律以雙引號括起來。例如，`my archive description,1` 做為 `"my archive description,1"` 傳回。在傳回的雙引號所括起的欄位中的雙引號字元，是藉由在其前面加上反斜線字元*逸出*。例如，`my archive description,1"2` 做為 `"my archive description,1\"2"` 傳回，`my archive description,1\"2` 做為 `"my archive description,1\\"2"` 傳回。反斜線字元不會逸出。

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

**ArchiveDescription**  
封存的說明。  
*類型：*字串

**封存**  
封存的 ID。  
*類型：*字串

**ArchiveList**  
封存中繼資料的陣列。陣列中的每個物件表示文件庫中包含的一個存檔的中繼資料。  
*類型*：陣列

**CreationDate**  
建立封存的 UTC 日期和時間。  
*類型*：ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**InventoryDate**  
在文件庫變更後完成的文件庫的最後清查的 UTC 日期和時間。即使 Amazon Glacier 每天準備一次保存庫庫存，只有在自上次庫存以來保存庫有存檔新增或刪除時，才會更新庫存日期。  
*類型*：ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**SHA256TreeHash**  
封存的樹狀雜湊。  
*類型：*字串

**大小**  
封存的大小 (位元組)。  
*類型*：數字

**VaultARN**  
請求封存擷取的 Amazon Resource Name (ARN) 資源。  
*類型：*字串

### 錯誤
<a name="api-job-output-get-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-job-output-get-examples"></a>

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

### 範例 1：下載輸出
<a name="api-job-output-get-examplesEx1"></a>

此範例會擷取 Amazon Glacier 為回應啟動封存擷取任務請求而準備的資料。

#### 範例請求
<a name="api-job-output-get-example-request"></a>

```
1. GET /-/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID/output HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-job-output-get-example-response"></a>

以下是封存擷取作業的範例回應。請注意，`Content-Type` 標頭是 `application/octet-stream`，並且 `x-amz-sha256-tree-hash` 標頭包含在回應中，這表示傳回所有任務資料。

```
1. HTTP/1.1 200 OK
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. x-amz-sha256-tree-hash: beb0fe31a1c7ca8c6c04d574ea906e3f97b31fdca7571defb5b44dca89b5af60
4. Date: Wed, 10 Feb 2017 12:00:00 GMT
5. Content-Type: application/octet-stream
6. Content-Length: 1048576
7. 
8. [Archive data.]
```

以下是庫存擷取任務的範例回應。請注意，`Content-Type` 標頭是 `application/json`。另請注意，回應不包含 `x-amz-sha256-tree-hash` 標頭。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 906
 6. 
 7. {
 8.  "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault",
 9.  "InventoryDate": "2011-12-12T14:19:01Z",
10.  "ArchiveList": [
11.    {
12.      "ArchiveId": "DMTmICA2n5Tdqq5BV2z7og-A20xnpAPKt3UXwWxdWsn_D6auTUrW6kwy5Qyj9xd1MCE1mBYvMQ63LWaT8yTMzMaCxB_9VBWrW4Jw4zsvg5kehAPDVKcppUD1X7b24JukOr4mMAq-oA",
13.      "ArchiveDescription": "my archive1",
14.      "CreationDate": "2012-05-15T17:19:46.700Z",
15.      "Size": 2140123,
16.      "SHA256TreeHash": "6b9d4cf8697bd3af6aa1b590a0b27b337da5b18988dbcc619a3e608a554a1e62"
17.    },
18.    {
19.      "ArchiveId": "2lHzwhKhgF2JHyvCS-ZRuF08IQLuyB4265Hs3AXj9MoAIhz7tbXAvcFeHusgU_hViO1WeCBe0N5lsYYHRyZ7rrmRkNRuYrXUs_sjl2K8ume_7mKO_0i7C-uHE1oHqaW9d37pabXrSA",
20.      "ArchiveDescription": "my archive2",
21.      "CreationDate": "2012-05-15T17:21:39.339Z",
22.      "Size": 2140123,
23.      "SHA256TreeHash": "7f2fe580edb35154041fa3d4b41dd6d3adaef0c85d2ff6309f1d4b520eeecda3"
24.    }
25.   ]
26. }
```

### 範例 2：僅下載部分輸出
<a name="api-job-output-get-examples2"></a>

此範例只會擷取 Amazon Glacier 為回應啟動封存擷取任務請求而準備的一部分封存。請求使用可選的 `Range` 標頭只擷取前 1,024 位元組。

#### 範例請求
<a name="api-job-output-get-example-request2"></a>

```
1. GET /-/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID/output HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. Range: bytes=0-1023	
5. x-amz-glacier-version: 2012-06-01
6. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-job-output-get-example-response2"></a>

以下成功回應顯示 `206 Partial Content` 回應。在此情況下，回應也包含一個`Content-Range`標頭，指定 Amazon Glacier 傳回的位元組範圍。

```
1. HTTP/1.1 206 Partial Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
4. Content-Range: bytes 0-1023/8388608
5. Content-Type: application/octet-stream
6. Content-Length: 1024
7. 
8. [Archive data.]
```

## 相關章節
<a name="related-sections-job-output-archive-retrieval"></a>

 
+ [描述任務 (GET JobID)](api-describe-job-get.md)
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 啟動任務 (POST 任務)
<a name="api-initiate-job-post"></a>

此操作會啟動下列類型的 Amazon Glacier (Amazon Glacier) 任務：
+ `archive-retrieval`：擷取封存
+ `inventory-retrieval`：清點保存庫

**Topics**
+ [初始化封存或保存庫庫存擷取工作](#api-initiate-job-post-description)
+ [要求](#api-initiate-job-post-requests)
+ [回應](#api-initiate-job-post-responses)
+ [範例](#api-initiate-job-post-examples)
+ [相關章節](#more-info-api-initiate-job-post)

## 初始化封存或保存庫庫存擷取工作
<a name="api-initiate-job-post-description"></a>

擷取封存或保存庫庫存是非同步作業，需要您啟動工作。一旦啟動，就無法取消任務。擷取是兩個步驟：

1. 使用 [啟動任務 (POST 任務)](#api-initiate-job-post) 操作啟動擷取任務。
**重要**  
資料擷取政策可能導致啟動擷取作業請求失敗，並出現 `PolicyEnforcedException`。如需有關資料擷取政策的詳細資訊，請參閱 [Amazon Glacier 資料擷取政策](data-retrieval-policy.md)。如需 `PolicyEnforcedException` 例外狀況的詳細資訊，請參閱 [錯誤回應](api-error-responses.md)。

1. 任務完成後，使用 [「取得任務輸出」 (GET 輸出)](api-job-output-get.md) 操作下載位元組。

以非同步方式執行擷取請求。當您起始檢索任務時，Amazon Glacier 會建立任務，並在回應中傳回任務 ID。當 Amazon Glacier 完成任務時，您可以取得任務輸出 （封存或庫存資料）。如需有關取得任務輸出的詳細資訊，請參閱 [「取得任務輸出」 (GET 輸出)](api-job-output-get.md) 操作。

必須完成任務，才能取得其輸出。若要判斷任務何時完成，您有下列選項：

 
+ **使用 Amazon SNS 通知 —** 您可以指定 Amazon Glacier 可以在任務完成後發佈通知的 Amazon SNS 主題。 Amazon Glacier 您可以為每個任務請求指定一個 SNS 主題。只有在 Amazon Glacier 完成任務後，才會傳送通知。除了指定每個工作請求的 SNS 主題外，還可以為保存庫設定保存庫通知，以便為所有擷取傳送工作通知。如需詳細資訊，請參閱[設定保存庫通知組態 (PUT 通知的組態)](api-vault-notifications-put.md)。
+ **取得工作詳細資訊：**工作進行中時，您可以提出 [描述任務 (GET JobID)](api-describe-job-get.md) 請求以取得工作狀態資訊。但是，使用 Amazon SNS 通知來判斷工作何時完成會更有效率。

 

**注意**  
您透過通知取得的資訊，與您呼叫 [描述任務 (GET JobID)](api-describe-job-get.md) 所取得的資訊相同。

如果針對特定事件，您可以在保存庫上新增通知組態，並在啟動任務請求中指定 SNS 主題，Amazon Glacier 會傳送這兩個通知。如需詳細資訊，請參閱[設定保存庫通知組態 (PUT 通知的組態)](api-vault-notifications-put.md)。

### 此保存庫庫存
<a name="api-initiate-job-post-about-the-vault-inventory"></a>

Amazon Glacier 大約每天更新一次保存庫庫存，從您第一次將封存上傳至保存庫的那一天開始。如果從上次清查以來，沒有新增或刪除文件庫的存檔，則清查日期不會更新。當您啟動保存庫庫存的任務時，Amazon Glacier 會傳回其產生的最後一個庫存，這是point-in-time快照，而不是即時資料。

Amazon Glacier 為保存庫建立第一個庫存後，通常需要半天到一天的時間才能擷取該庫存。

您可能沒有發現為每個存檔上傳擷取文件庫清查的好處。不過，假設您在用戶端維護資料庫，關聯您上傳到 Amazon Glacier 之封存的相關中繼資料。然後，您可能會發現文件庫清查的好處，可以視需要在資料庫中使用實際的文件庫清查來調節資訊。如需有關庫存任務輸出中傳回的資料欄位的詳細資訊，請參閱 [回應內文](api-job-output-get.md#api-job-output-get-responses-elements)。

### 庫存擷取範圍
<a name="api-initiate-job-post-vault-inventory-list-filtering"></a>

 您可以透過篩選在保存庫建立日期或設定限制來限制擷取到的保存庫庫存項目的數量。

**透過封存建立日期進行篩選**  
您可以透過在**啟動工作**請求中指定這些參數的值，來擷取在 `StartDate` 和 `EndDate` 之間建立之封存的庫存項目。在 `StartDate` 之時或之後，以及 `EndDate` 之前所建立的封存被傳回。如果您只提供沒有 `StartDate` 的 `EndDate` ，則擷取 `StartDate` 或之後建立的所有封存的庫存。如果您只提供 `EndDate` 而沒有 `StartDate`，則擷取 `EndDate` 之時或之後所建立的所有封存的庫存。

**限制每個擷取的庫存項目**  
 您可以透過在**啟動工作**請求中設定 `Limit` 參數，來限制傳回的庫存項目數量。庫存任務輸出包含達到指定 `Limit` 的庫存項目。如果有更多的庫存項目可用，則結果會進行分頁。在任務完成後，您可以使用 [描述任務 (GET JobID)](api-describe-job-get.md) 操作來取得您在後續的**啟動任務**請求中使用的標記。標記指示要擷取下一組庫存項目的起點。您可以透過使用之前**描述工作**輸出中的標記重複建立**啟動工作**請求來瀏覽整個庫存。這樣做一直到您從**描述任務**取得傳回空標記，表示沒有更多的庫存項目可用。

您可以將 `Limit` 參數與日期範圍參數一起使用。

### 遠端封存擷取
<a name="api-initiate-job-post-"></a>

您可以為整個封存或封存範圍啟動封存擷取。在遠端封存擷取的情況下，指定要傳回的位元組範圍或整個封存。指定的範圍必須符合百萬位元組 (MB)。換言之，範圍起始值必須可被 1 MB 整除，並且範圍結束值加上 1 必須可整除 1 MB 或等於封存的結束。如果遠端封存擷取不符合 MB，則此操作將傳回 `400` 回應。此外，為了確保使用**取得任務輸** ([「取得任務輸出」 (GET 輸出)](api-job-output-get.md)) 下載的資料取得檢查總和值，該範圍必須必須符合樹狀雜湊。如需有關樹狀雜湊符合範圍的詳細資訊，請參閱 [下載資料時接收檢查總和](checksum-calculations-range.md)。

### 急件、標準和大量方案
<a name="api-initiate-job-expedited-bulk"></a>

當啟動封存擷取工作時，可以在請求內文的 `Tier` 欄位中指定下列選項之一：
+ **`Expedited`**：當您偶爾需要緊急要求還原封存時，急件讓您快速存取資料。對於幾乎最大型的封存 (250 MB 以上)，使用急件方案所存取的資料，通常會在 1-5 分鐘內即可使用。
+ **`Standard`**：讓您能以標準方案在幾小時內存取任何封存。使用標準方案存取的資料通常 3 -5 小時內可用。若未指定方案選項，這會是任務請求的預設選項。
+ **`Bulk`** – 大量是 Amazon Glacier 成本最低的方案，可讓您在一天內以經濟實惠的價格擷取大量資料，甚至 PB。使用大量方案存取的資料通常 5 -12 小時內可用。

如需有關急件和大量擷取的詳細資訊，請參閱 [擷取 Amazon Glacier Archives](downloading-an-archive-two-steps.md)。

## 要求
<a name="api-initiate-job-post-requests"></a>

要啟動作業，您可以使用 HTTP `POST` 方法的請求，並將請求範圍擴大到保存庫的 `jobs` 子資源。您可以在請求的 JSON 文件中指定任務請求的詳細資訊。任務類型是由 `Type` 欄位指定的。或者，您可以指定 `SNSTopic` 欄位，以指示 Amazon Glacier 在完成任務後可發佈通知的 Amazon SNS 主題。 Amazon Glacier 

 

**注意**  
若要將通知發佈到 Amazon SNS，如果主題尚不存在，您必須自行建立該主題。Amazon Glacier 不會為您建立主題。主題必須具有從 Amazon Glacier 保存庫接收出版物的許可。Amazon Glacier 不會驗證保存庫是否具有發佈至主題的許可。如果未設定適當的權限，即使任務完成後，您也可能不會收到通知。

### 語法
<a name="api-initiate-job-post-requests-syntax"></a>

以下是啟動任務的請求語法。

```
 1. POST /AccountId/vaults/VaultName/jobs HTTP/1.1
 2. Host: glacier.Region.amazonaws.com
 3. Date: Date
 4. Authorization: SignatureValue
 5. x-amz-glacier-version: 2012-06-01
 6. 
 7. {
 8.    "jobParameters": { 
 9.       "ArchiveId": "string",
10.       "Description": "string",
11.       "Format": "string",
12.       "InventoryRetrievalParameters": { 
13.          "EndDate": "string",
14.          "Limit": "string",
15.          "Marker": "string",
16.          "StartDate": "string"
17.       },
18.       "OutputLocation": { 
19.          "S3": { 
20.             "AccessControlList": [ 
21.                { 
22.                   "Grantee": { 
23.                      "DisplayName": "string",
24.                      "EmailAddress": "string",
25.                      "ID": "string",
26.                      "Type": "string",
27.                      "URI": "string"
28.                   },
29.                   "Permission": "string"
30.                }
31.             ],
32.             "BucketName": "string",
33.             "CannedACL": "string",
34.             "Encryption": { 
35.                "EncryptionType": "string",
36.                "KMSContext": "string",
37.                "KMSKeyId": "string"
38.             },
39.             "Prefix": "string",
40.             "StorageClass": "string",
41.             "Tagging": { 
42.                "string" : "string" 
43.             },
44.             "UserMetadata": { 
45.                "string" : "string" 
46.             }
47.          }
48.       },
49.       "RetrievalByteRange": "string",
50.       "SelectParameters": { 
51.          "Expression": "string",
52.          "ExpressionType": "string",
53.          "InputSerialization": { 
54.             "csv": { 
55.                "Comments": "string",
56.                "FieldDelimiter": "string",
57.                "FileHeaderInfo": "string",
58.                "QuoteCharacter": "string",
59.                "QuoteEscapeCharacter": "string",
60.                "RecordDelimiter": "string"
61.             }
62.          },
63.          "OutputSerialization": { 
64.             "csv": { 
65.                "FieldDelimiter": "string",
66.                "QuoteCharacter": "string",
67.                "QuoteEscapeCharacter": "string",
68.                "QuoteFields": "string",
69.                "RecordDelimiter": "string"
70.             }
71.          }
72.       },
73.       "SNSTopic": "string",
74.       "Tier": "string",
75.       "Type": "string"
76.    }
77. }
```

**注意**  
 `AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求主體
<a name="api-initiate-job-post-select-request-body"></a>

該請求接受請求內文中的 JSON 格式的以下資料。

jobParameters  
提供指定任務資訊的選項。  
*類型*：[jobParameters](api-jobParameters.md)物件  
*必要*：是 

## 回應
<a name="api-initiate-job-post-responses"></a>

Amazon Glacier 會建立任務。在回應中，它會傳回任務的 URI。

### 語法
<a name="api-initiate-job-post-response-syntax"></a>

```
1. HTTP/1.1 202 Accepted
2. x-amzn-RequestId: x-amzn-RequestId
3. Date: Date
4. Location: location
5. x-amz-job-id: jobId
6. x-amz-job-output-path: jobOutputPath
```

### 回應標頭
<a name="api-initiate-job-post-responses-headers"></a>


| 標頭 | Description | 
| --- | --- | 
| Location |  任務的相對 URI 路徑。您可以使用此 URI 路徑來尋找任務狀態。如需詳細資訊，請參閱[描述任務 (GET JobID)](api-describe-job-get.md)。 類型：字串 預設：無  | 
| x-amz-job-id |  任務的 ID。此值也包含在 `Location` 標頭中。 類型：字串 預設：無  | 
| x-amz-job-output-path |  儲存選取結果的位置的路徑。 類型：字串 預設：無  | 

### 回應內文
<a name="api-initiate-job-post-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-initiate-job-post-responses-errors"></a>

除了所有 Amazon Glacier 操作常見的可能錯誤之外，此操作還包含下列錯誤。如需 Amazon Glacier 錯誤的資訊和錯誤代碼清單，請參閱 [錯誤回應](api-error-responses.md)。


| Code | Description | HTTP 狀態碼 | Type | 
| --- | --- | --- | --- | 
| InsufficientCapacityException | 如果沒有足夠的能力處理此急件請求，則退回。此錯誤僅適用於急件擷取，而不適用於標準或大量擷取。 | 503 Service Unavailable | Server | 

## 範例
<a name="api-initiate-job-post-examples"></a>

### 範例請求：啟動封存擷取任務
<a name="api-initiate-job-post-example-request"></a>

```
 1. POST /-/vaults/examplevault/jobs HTTP/1.1
 2. Host: glacier.us-west-2.amazonaws.com
 3. x-amz-Date: 20170210T120000Z
 4. x-amz-glacier-version: 2012-06-01
 5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
 6. 
 7. {
 8.   "Type": "archive-retrieval",
 9.   "ArchiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
10.   "Description": "My archive description",
11.   "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-ArchiveRetrieval-topic-Example",
12.   "Tier" : "Bulk"
13. }
```

以下是一個請求內文的範例，該請求指定各種封存擷取使用 `RetrievalByteRange` 欄位。

 

```
{
  "Type": "archive-retrieval",
  "ArchiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
  "Description": "My archive description",
  "RetrievalByteRange": "2097152-4194303",
  "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-ArchiveRetrieval-topic-Example",
  "Tier" : "Bulk"
}
```

### 回應範例
<a name="api-initiate-job-post-example-response"></a>

```
1. HTTP/1.1 202 Accepted
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT
4. Location: /111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
5. x-amz-job-id: HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
```

### 範例請求：啟動庫存擷取任務
<a name="api-initiate-job-post-example-retrieve-inventory-request"></a>

以下請求將啟動一個庫存擷取工作，以便從 `examplevault` 保存庫中取得封存清單。在請求內文中的 `Format` 設為 `CSV` 表示庫存以 CSV 格式傳回。

```
 1. POST /-/vaults/examplevault/jobs HTTP/1.1
 2. Host: glacier.us-west-2.amazonaws.com
 3. x-amz-Date: 20170210T120000Z
 4. Content-Type: application/x-www-form-urlencoded
 5. x-amz-glacier-version: 2012-06-01
 6. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
 7. 
 8. {
 9.   "Type": "inventory-retrieval",
10.   "Description": "My inventory job",
11.   "Format": "CSV",  
12.   "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example"
13. }
```

### 回應範例
<a name="api-initiate-job-post-example-retrieve-inventory-response"></a>

```
1. HTTP/1.1 202 Accepted
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT 
4. Location: /111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
5. x-amz-job-id: HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
```

### 範例請求：通過使用一組限制的日期篩選和後續請求來擷取庫存項目的下一頁，啟動庫存擷取任務。
<a name="api-initiate-job-post-example-retrieve-inventory-request-filtered"></a>

以下請求透過使用日期篩選和設定限制來啟動保存庫庫存擷取工作。

```
 1. {
 2.     "ArchiveId": null, 
 3.     "Description": null, 
 4.     "Format": "CSV", 
 5.     "RetrievalByteRange": null, 
 6.     "SNSTopic": null, 
 7.     "Type": "inventory-retrieval", 
 8.     "InventoryRetrievalParameters": {
 9.         "StartDate": "2013-12-04T21:25:42Z",
10.         "EndDate": "2013-12-05T21:25:42Z", 
11.         "Limit" : "10000"
12.     }, 
13. }
```

以下的請求範例，後續請求使用來自 [描述任務 (GET JobID)](api-describe-job-get.md) 所取得的標記來擷取庫存項目的下一頁。

```
 1. {
 2.     "ArchiveId": null, 
 3.     "Description": null, 
 4.     "Format": "CSV", 
 5.     "RetrievalByteRange": null, 
 6.     "SNSTopic": null, 
 7.     "Type": "inventory-retrieval", 
 8.     "InventoryRetrievalParameters": {
 9.         "StartDate": "2013-12-04T21:25:42Z",
10.         "EndDate": "2013-12-05T21:25:42Z", 
11.         "Limit": "10000",
12.         "Marker": "vyS0t2jHQe5qbcDggIeD50chS1SXwYMrkVKo0KHiTUjEYxBGCqRLKaiySzdN7QXGVVV5XZpNVG67pCZ_uykQXFMLaxOSu2hO_-5C0AtWMDrfo7LgVOyfnveDRuOSecUo3Ueq7K0"
13.     }, 
14. }
```

### 回應範例
<a name="api-initiate-job-post-example-select-response"></a>

```
1. HTTP/1.1 202 Accepted
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:00:00 GMT 
4. Location: /111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
5. x-amz-job-id: HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
6. x-amz-job-output-path: test/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID/
```

## 相關章節
<a name="more-info-api-initiate-job-post"></a>

 
+ [描述任務 (GET JobID)](api-describe-job-get.md)
+ [「取得任務輸出」 (GET 輸出)](api-job-output-get.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md)

# 列出工作 (GET 工作)
<a name="api-jobs-get"></a>

## Description
<a name="api-jobs-get-description"></a>

此操作列出文件庫的任務，包括正在進行的任務和最近完成的任務。

 

**注意**  
Amazon Glacier (Amazon Glacier) 會在刪除任務之前保留最近完成的任務一段時間；不過，最終會移除已完成的任務。可以擷取完成工作的輸出。在完成工作後，工作將保留一段時間，可使您可以在錯過工作完成通知的情況下取得工作輸出，否則您第一次嘗試下載工作時會失敗。例如，假設您啟動封存擷取工作以下載封存。工作完成後，您開始下載封存，但發生網路錯誤。在此案例中，您可以在工作存在時重試並下載封存。

`List Jobs` 操作支援分頁。您應該隨時檢查回應 `Marker` 欄位。如果沒有更多的工作要列出，`Marker` 欄位設定為 `null`。如果要列出更多工作，`Marker` 欄位將設定為非空值，您可以使用該值來繼續清單的分頁。若要傳回從特定工作開始的工作清單，請將 `marker` 請求參數設定為從之前的 `Marker` 請求取得的工作的 `List Jobs` 值。

您可以透過在請求中指定 `limit` 參數來設定回應中傳回的工作數量的最大限制。預設限制為 50。傳回的工作數可能少於限制，但傳回的工作數永遠不會超過限制。

此外，還可以透過指定選用的 `statuscode` 參數或 `completed` 參數或兩者來篩選傳回的工作清單。使用 `statuscode` 參數，可以指定僅返回與 `InProgress`、`Succeeded` 或 `Failed` 狀態符合的工作。使用 `completed` 參數，您可以指定只傳回已完成的 (`true`) 的工作或未完成的 (`false`) 的工作。

## 要求
<a name="api-jobs-get-requests"></a>

### 語法
<a name="api-jobs-get-requests-syntax"></a>

 要傳回所有類型的任務清單, 請將 `GET` 請求傳送到文件庫的 `jobs` 子資源的 URI。

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

 

**注意**  
`AccountId` 值是擁有保存庫的帳戶 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您使用帳號 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-jobs-get-requests-parameters"></a>


|  名稱  |  描述  |  必要  | 
| --- | --- | --- | 
| completed  |  要傳回的工作狀態。您可指定為 `true` 或 `false`。 類型：布林值 限制條件：無  |  否  | 
|  limit  |  所要傳回的工作數量上限。預設限制為 50。傳回的工作數可能少於指定的限制，但傳回的工作數永遠不會超過限制。 類型：字串 限制：最小整數值為 1。最大整數值為 50。  |  否 | 
| marker  |  用於分頁的不透明字串，用於指定工作清單應開始的工作。您可以從之前的 `marker` 回應中取得 `List Jobs` 值。如果您要繼續分析在之前的 `marker` 請求中啟動的結果，則只需包含 `List Jobs`。 類型：字串 限制條件：無  |  否  | 
| statuscode  |  傳回的工作狀態類型。 類型：字串 限制：`InProgress`、`Succeeded` 或 `Failed` 的其中一個值。  |  否  | 

### 請求標頭
<a name="api-jobs-get-requests-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 請求主體
<a name="api-jobs-get-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-jobs-get-responses"></a>

### 語法
<a name="api-jobs-get-responses-syntax"></a>

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

### 回應標頭
<a name="api-jobs-get-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-jobs-get-responses-elements"></a>

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

**JobList**  
工作物件的清單。每個工作物件包含描述工作的中繼資料。  
*類型*：[GlacierJobDescription](api-GlacierJobDescription.md) 物件陣列

**Marker**  
一個不透明字串，表示繼續結果分頁之處。您可以在新的 `marker` 請求中使用 ` List Jobs` 值來取得清單中的更多工作。如果沒有更多的工作列出，則此值為 `null`。  
*類型：*字串

### 錯誤
<a name="api-jobs-get-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-jobs-get-examples"></a>

以下範例示範如何傳回有關文件庫任務的資訊。第一個範例傳回兩個工作清單，第二個範例傳回部分工作。

### 範例：傳回所有工作
<a name="api-jobs-get-example-requestExample1"></a>

#### 範例請求
<a name="api-jobs-get-example-request"></a>

以下 `GET` 請求傳回文件庫的任務。

```
1. GET /-/vaults/examplevault/jobs  HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-jobs-get-example-response"></a>

以下回應包括存檔擷取任務和清查擷取任務，其中包含用來持續對文件庫清查擷取進行分頁的標記。回應還會顯示 `Marker` 欄位設定為 `null`，這表示沒有更多的工作列出。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT 
 4. Content-Type: application/json
 5. Content-Length: 1444
 6. 
 7. {
 8.   "JobList": [
 9.     {
10.       "Action": "ArchiveRetrieval",
11.       "ArchiveId": "BDfaUQul0dVzYwAMr8YSa_6_8abbhZq-i1oT69g8ByClfJyBgAGBkWl2QbF5os851P7Y7KdZDOHWJIn4rh1ZHaOYD3MgFhK_g0oDPesW34uHQoVGwoIqubf6BgUEfQm_wrU4Jlm3cA",
12.       "ArchiveSizeInBytes": 1048576,
13.       "ArchiveSHA256TreeHash": "25499381569ab2f85e1fd0eb93c5406a178ab77c5933056eb5d6e7d4adda609b",
14.       "Completed": true,
15.       "CompletionDate": "2012-05-01T00:00:09.304Z",
16.       "CreationDate": "2012-05-01T00:00:06.663Z",
17.       "InventorySizeInBytes": null,
18.       "JobDescription": null,
19.       "JobId": "hDe9t9DTHXqFw8sBGpLQQOmIM0-JrGtu1O_YFKLnzQ64548qJc667BRWTwBLZC76Ygy1jHYruqXkdcAhRsh0hYv4eVRU",
20.       "RetrievalByteRange": "0-1048575",
21.       "SHA256TreeHash": "25499381569ab2f85e1fd0eb93c5406a178ab77c5933056eb5d6e7d4adda609b",
22.       "SNSTopic": null,
23.       "StatusCode": "Succeeded",
24.       "StatusMessage": "Succeeded",
25.       "Tier": "Bulk",
26.       "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
27.     },
28.     {
29.       "Action": "InventoryRetrieval",
30.       "ArchiveId": null,
31.       "ArchiveSizeInBytes": null,
32.       "ArchiveSHA256TreeHash": null,
33.       "Completed": true,
34.       "CompletionDate": "2013-05-11T00:25:18.831Z",
35.       "CreationDate": "2013-05-11T00:25:14.981Z",
36.       "InventorySizeInBytes": 1988,
37.       "JobDescription": null,
38.       "JobId": "2cvVOnBL36btzyP3pobwIceiaJebM1bx9vZOOUtmNAr0KaVZ4WkWgVjiPldJ73VU7imlm0pnZriBVBebnqaAcirZq_C5",
39.       "RetrievalByteRange": null,
40.       "SHA256TreeHash": null,
41.       "SNSTopic": null,
42.       "StatusCode": "Succeeded",
43.       "StatusMessage": "Succeeded",
44.       "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
45.       "InventoryRetrievalParameters": {
46.           "StartDate": "2013-11-12T13:43:12Z",
47.           "EndDate": "2013-11-20T08:12:45Z", 
48.           "Limit": "120000",
49.           "Format": "JSON",
50.           "Marker": "vyS0t2jHQe5qbcDggIeD50chS1SXwYMrkVKo0KHiTUjEYxBGCqRLKaiySzdN7QXGVVV5XZpNVG67pCZ_uykQXFMLaxOSu2hO_-5C0AtWMDrfo7LgVOyfnveDRuOSecUo3Ueq7K0"
51.     }
52.   ],
53.   "Marker": null  
54. }
```

### 範例：回傳工作的局部清單
<a name="api-jobs-get-example-request-example2"></a>

#### 範例請求
<a name="api-jobs-get-example-request2"></a>

以下 `GET` 請求傳回由 `marker` 參數指定的工作。將 `limit` 參數設定為 `2` 以指定最多傳回兩個工作。

```
1. GET /-/vaults/examplevault/jobs?marker=HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID&limit=2  HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

#### 回應範例
<a name="api-jobs-get-example-response2"></a>

以下回應顯示傳回的兩個工作，`Marker` 欄位設定為非空值，可用來繼續工作清單的分頁。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT 
 4. Content-Type: application/json
 5. Content-Length: 1744
 6. 
 7. {
 8.   "JobList": [
 9.     {
10.       "Action": "ArchiveRetrieval",
11.       "ArchiveId": "58-3KpZfcMPUznvMZNPaKyJx9wODCsWTnqcjtx2CjKZ6b-XgxEuA8yvZOYTPQfd7gWR4GRm2XR08gcnWbLV4VPV_kDWtZJKi0TFhKKVPzwrZnA4-FXuIBfViYUIVveeiBE51FO4bvg",
12.       "ArchiveSizeInBytes": 8388608,
13.       "ArchiveSHA256TreeHash": "106086b256ddf0fedf3d9e72f461d5983a2566247ebe7e1949246bc61359b4f4",
14.       "Completed": true,
15.       "CompletionDate": "2012-05-01T00:25:20.043Z",
16.       "CreationDate": "2012-05-01T00:25:16.344Z",
17.       "InventorySizeInBytes": null,
18.       "JobDescription": "aaabbbccc",
19.       "JobId": "s4MvaNHIh6mOa1f8iY4ioG2921SDPihXxh3Kv0FBX-JbNPctpRvE4c2_BifuhdGLqEhGBNGeB6Ub-JMunR9JoVa8y1hQ",
20.       "RetrievalByteRange": "0-8388607",
21.       "SHA256TreeHash": "106086b256ddf0fedf3d9e72f461d5983a2566247ebe7e1949246bc61359b4f4",
22.       "SNSTopic": null,
23.       "StatusCode": "Succeeded",
24.       "StatusMessage": "Succeeded",
25.       "Tier": "Bulk",
26.       "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
27.     },
28.     {
29.       "Action": "ArchiveRetrieval",
30.       "ArchiveId": "2NVGpf83U6qB9M2u-Ihh61yoFLRDEoh7YLZWKBn80A2i1xG8uieBwGjAr4RkzOHA0E07ZjtI267R03Z-6Hxd8pyGQkBdciCSH1-Lw63Kx9qKpZbPCdU0uTW_WAdwF6lR6w8iSyKdvw",
31.       "ArchiveSizeInBytes": 1048576,
32.       "ArchiveSHA256TreeHash": "3d2ae052b2978727e0c51c0a5e32961c6a56650d1f2e4ceccab6472a5ed4a0",
33.       "Completed": true,
34.       "CompletionDate": "2012-05-01T16:59:48.444Z",
35.       "CreationDate": "2012-05-01T16:59:42.977Z",
36.       "InventorySizeInBytes": null,
37.       "JobDescription": "aaabbbccc",
38.       "JobId": "CQ_tf6fOR4jrJCL61Mfk6VM03oY8lmnWK93KK4gLig1UPAbZiN3UV4G_5nq4AfmJHQ_dOMLOX5k8ItFv0wCPN0oaz5dG",
39.       "RetrievalByteRange": "0-1048575",
40.       "SHA256TreeHash": "3d2ae052b2978727e0c51c0a5e32961c6a56650d1f2e4ceccab6472a5ed4a0",
41.       "SNSTopic": null,
42.       "StatusCode": "Succeeded",
43.       "StatusMessage": "Succeeded",
44.       "Tier": "Standard",
45.       "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
46.     }
47.   ],
48.   "Marker": "CQ_tf6fOR4jrJCL61Mfk6VM03oY8lmnWK93KK4gLig1UPAbZiN3UV4G_5nq4AfmJHQ_dOMLOX5k8ItFv0wCPN0oaz5dG"
49. }
```

## 相關章節
<a name="related-sections-list-jobs"></a>

 
+  [描述任務 (GET JobID)](api-describe-job-get.md)
+ [Amazon Glacier 的 Identity and Access Management](security-iam.md) 

# 在任務操作中使用的資料類型
<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**  
單一字元用於在記錄中分隔個別欄位 此字元必須是 32-126 範圍內的 `\n`、`\r` 或 ASCII 字元。預設為逗號 (`,`)。  
*類型：*字串  
*預設*：,  
*必要*：否

**FileHeaderInfo**  
一個值，用於描述如何處理輸入的第一行。  
*類型：*字串  
*有效值*：`Use` \$1 `Ignore` \$1 `None`   
  
*必要*：否

**QuoteCharacter**  
用作逸出字元的單一字元，其中欄位分隔符號是該值的一部分。  
*類型：*字串  
*必要*：否

**QuoteEscapeCharacter**  
單一字元，用於在已逸出的值內逸出引號字元。  
*類型：*字串  
*必要*：否

**RecordDelimiter**  
單一字元用於分隔個別紀錄。  
*類型：*字串  
*必要*：否

## 詳細資訊
<a name="more-info-api-CSVInput"></a>

 
+ [啟動任務 (POST 任務)](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 任務)](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 任務)](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`。  
*類型：*字串

**封存**  
針對選擇或封存擷取任務請求的封存 ID。否則，此欄位為 `null`。  
*類型：*字串

**ArchiveSHA256TreeHash**  
用於封存擷取的整個封存的 SHA256 樹狀雜湊。對於庫存擷取作業，此欄位為 `null`。  
*類型：*字串

**ArchiveSizeInBytes**  
對於 `ArchiveRetrieval` 任務，這是請求下載的封存的大小，以位元組為單位。對於 `InventoryRetrieval` 任務，值為 `null`。  
*類型*：數字

**已完成**  
如果任務完成後，則為 `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 任務)](api-initiate-job-post.md) 請求指定了樹狀雜湊值的範圍，則此欄位會傳回一個值。如需關於封存範圍擷取的樹狀雜湊值的詳細資訊，請參閱 [下載資料時接收檢查總和](checksum-calculations-range.md)。  
對於擷取整個封存的特定案例，此值與 `ArchiveSHA256TreeHash` 值相同。  
此欄位在以下情況下為 `null`：  
+ 封存擷取任務所指定的範圍不符合樹狀雜湊。
+ 指定與整個封存和任務狀態相等的範圍的封存任務是 `InProgress`。
+ 庫存任務
+ 選取任務。
*類型：*字串

**SNSTopic**  
如果在工作啟動 ([啟動任務 (POST 任務)](api-initiate-job-post.md)) 中設定了通知，則 Amazon Resource Name (ARN) 代表傳送工作完成或失敗的通知的 Amazon SNS 主題。  
*類型：*字串

**StatusCode**  
表示任務狀態的代碼。  
*有效值*：`InProgress` \$1 `Succeeded` \$1 `Failed`  
*類型：*字串

**StatusMessage**  
任務狀態訊息。  
*類型：*字串

**層**  
用於選擇或封存擷取的資料存方案。  
*有效值*：`Expedited` \$1 `Standard` \$1 `Bulk`  
*類型：*字串

**VaultARN**  
該工作是子資源的保存庫 ARN。  
*類型：*字串

## 詳細資訊
<a name="more-info-api-GlacierJobDescription"></a>
+ [啟動任務 (POST 任務)](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 任務)](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 任務)](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 任務)](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`。  
*必要*：否

**Format (格式)**  
 保存庫庫存清單的輸出格式，該清單是在啟動工作以擷取保存庫庫存時由 [啟動任務 (POST 任務)](api-initiate-job-post.md) 請求所設定的。  
*有效值*：`CSV` \$1 `JSON`   
*必要*：否  
*類型：*字串

**限制**  
 每個保存庫庫存擷取請求可以傳回的庫存項目的最大上限數。  
*有效值*：大於或等於 1 的整數值。  
*類型：*字串  
*必要*：否

**Marker**  
 一個不透明的字串，表示其繼續分頁的保存庫庫存擷取結果。您可以在新的 `Initiate Job` 請求中使用此標記來取得額外庫存項目。如果沒有其他庫存項目，這個值為空。  
*類型：*字串  
*必要*：否

**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 任務)](api-initiate-job-post.md)

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

提供選項來定義工作。

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

**封存**  
您想要封存的 ID。如果 `Type` 欄位設定為 `select` 或 `archive-retrieval`，則此欄位是必要的。如果為庫存擷取工作請求指定此欄位，則會發生錯誤。  
*有效值*：必須是您從先前對 Amazon Glacier (Amazon Glacier) 的請求取得的有效封存 ID。  
*類型：*字串  
*必要 *：是，當 `Type` 設定為 `select` 或 `archive-retrieval`。

**描述**  
工作的可選說明。  
* 有效值 *：描述必須小於或等於 1,024 位元組。允許的字元是沒有控制代碼的 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*」。如果不指定此欄位，則擷取整個封存。如果指定此欄位，則位元組範圍必須符合 MB (1024\$1 1024)。MB - 符合表示 *StartByteValue* 必須被 1 MB 整除，並且 *EndByteValue* 加上 1 必須可被 1 MB 整除或者是指定為封存位元組大小值減去 1 的封存的結尾。如果 **RetrievalByteRange** 不符合 MB，則此操作將傳回 `400` 回應。  
如果為 `inventory-retrieval` 或 `select` 工作請求指定此欄位，則會發生錯誤。  
*類型：*字串  
*必要*：否

**SelectParameters**  
一個物件，其中包含有關用於選擇的參數的資訊。  
*類型*：[SelectParameters](api-SelectParameters.md)物件  
*必要*：否

**SNSTopic**  
Amazon Glacier 在任務完成且輸出準備好供您下載時傳送通知的 Amazon SNS 主題的 Amazon Resource Name (ARN)。 Amazon Glacier 定的主題將通知發佈到其訂閱伺服器。  
SNS 主題必須存在。如果沒有，Amazon Glacier 不會為您建立。此外，SNS 主題必須具有政策，可讓已建立工作的帳戶將訊息發佈到該主題。如需有關 SNS 主題名稱的詳細資訊，請參閱 [Amazon Simple Notification Service](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html) *API 參考* 中的 *CreateTopic*。  
*類型：*字串  
*必要*：否

**層**  
用於選擇或封存擷取工作的方案。`Standard` 是使用的預設值。  
*有效值*：`Expedited` \$1 `Standard` \$1 `Bulk`  
*類型：*字串  
*必要*：否 

**類型**  
工作類型。您可以啟動 任務，對存檔執行 select 查詢、擷取存檔或取得文件庫的清查。  
*有效值*：`select` \$1 `archive-retrieval` \$1 `inventory-retrieval`   
*類型：*字串  
*必要*：是

## 詳細資訊
<a name="more-info-api-jobParameters"></a>
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

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

 包含關於儲存任務結果和錯誤的位置的資訊。

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

**S3**  
一個物件描述了 Amazon S3 位置以接收還原請求的結果。  
*Type (類型)*：[S3Location](api-S3Location.md)  
*必要*：是

## 詳細資訊
<a name="more-info-api-OutputLocation"></a>
+ [啟動任務 (POST 任務)](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 任務)](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)物件  
*必要*：否

**字首**  
此字首要追加在該請求結果的前面。字首的最大長度為 512 位元組。  
*類型：*字串  
*必要*：是

**StorageClass**  
用於儲存任務結果的任務類別。  
*類型：*字串  
*有效值*：`STANDARD` \$1 `REDUCED_REDUNDANCY` \$1 `STANDARD_IA`  
*必要*：否

**標記**  
套用到任務結果的標籤集。  
*類型*：字串到字串對應  
*必要*：否

**UserMetadata**  
要隨工作結果儲存於 Amazon S3 之中繼資料的對應。  
*類型*：字串到字串對應  
*必要*：否

## 詳細資訊
<a name="more-info-api-S3Location"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

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

包含有關用於選擇的參數的資訊。

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

**運算式**  
用於選擇物件的運算式。運算式不得超過 128,000 個字元的配額。  
*類型：*字串  
*必要*：是

**ExpressionType**  
提供的運算式的類型，例如 `SQL`。  
*有效值*：`SQL`  
*類型：*字串  
*必要*：是

**InputSerialization**  
描述在該選擇中的物件的序列化格式。  
*類型*：[InputSerialization](api-InputSerialization.md)物件  
*必要*：否

**OutputSerialization**  
描述如何序列化選擇任務的結果。  
*必要*：否  
*類型*：[OutputSerialization](api-OutputSerialization.md)物件

## 詳細資訊
<a name="more-info-api-SelectParameters"></a>

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# 資料擷取操作
<a name="data-retrieval-policy-operations"></a>

以下是 Amazon Glacier 中可用的資料擷取相關操作。

**Topics**
+ [取得資料擷取政策 (GET 政策)](api-GetDataRetrievalPolicy.md)
+ [列出佈建容量 (GET 佈建的容量)](api-ListProvisionedCapacity.md)
+ [購買佈建容量 (POST 佈建的容量)](api-PurchaseProvisionedCapacity.md)
+ [設定資料擷取政策 (PUT 政策)](api-SetDataRetrievalPolicy.md)

# 取得資料擷取政策 (GET 政策)
<a name="api-GetDataRetrievalPolicy"></a>

## 說明
<a name="api-GetDataRetrievalPolicy-description"></a>

此操作會傳回`GET`請求中指定之 AWS 帳戶 和 AWS 區域的目前資料擷取政策。如需有關資料擷取政策的詳細資訊，請參閱 [Amazon Glacier 資料擷取政策](data-retrieval-policy.md)。

## 請求
<a name="api-GetDataRetrievalPolicy-requests"></a>

要傳回目前的資料擷取政策、傳送 HTTP `GET` 請求到資料擷取政策 URI 如下語法範例。

### 語法
<a name="api-GetDataRetrievalPolicy-requests-syntax"></a>

```
1. GET /AccountId/policies/data-retrieval HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID 相符。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-GetDataRetrievalPolicy-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-GetDataRetrievalPolicy-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-GetDataRetrievalPolicy-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-GetDataRetrievalPolicy-responses"></a>

### 語法
<a name="api-GetDataRetrievalPolicy-responses-syntax"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: length
{
  "Policy":
    {
      "Rules":[
         {
            "BytesPerHour": Number,
            "Strategy": String	 
         }
       ]
    }
}
```

### 回應標頭
<a name="api-GetDataRetrievalPolicy-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-GetDataRetrievalPolicy-responses-elements"></a>

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

 

**BytesPerHour**  
最多可在一小時內擷取的位元組數。  
只有當**策略**欄位的值為 `BytesPerHour` 時，此欄位才會出現。  
*類型*：數字

**規則**  
政策規則。雖然這是清單類型，但目前只會有一個規則，其中包含策略欄位和可選的 BytesPerHour 欄位。  
*類型*：陣列

**策略**  
資料擷取政策的類型。  
*類型：*字串  
有效值：`BytesPerHour`\$1`FreeTier`\$1`None`。`BytesPerHour` 相當於在主控台中選擇**最大擷取率**。`FreeTier` 相當於在主控台中選擇**僅限免費方案**。`None` 相當於在主控台中選擇**無擷取政策**。如需在主控台中選擇資料擷取政策的詳細資訊，請參閱 [Amazon Glacier 資料擷取政策](data-retrieval-policy.md)。

### 錯誤
<a name="api-GetDataRetrievalPolicy-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-GetDataRetrievalPolicy-examples"></a>

以下範例示範如何取得資料擷取政策。

### 範例請求
<a name="api-GetDataRetrievalPolicy-example-request"></a>

在這個範例中，將 `GET` 請求傳送到政策位置的 URI。

```
1. GET /-/policies/data-retrieval HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-GetDataRetrievalPolicy-example-response"></a>

成功的回應以 JSON 格式顯示回應內文中的資料擷取政策。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:00:00 GMT
 4. Content-Type: application/json
 5. Content-Length: 85
 6.  
 7. {
 8.   "Policy":
 9.     {
10.       "Rules":[
11.          {
12.            "BytesPerHour":10737418240,
13.            "Strategy":"BytesPerHour"
14.           }
15.        ]
16.     }
17. }
```

## 相關章節
<a name="related-sections-GetDataRetrievalPolicy"></a>

 
+ [設定資料擷取政策 (PUT 政策)](api-SetDataRetrievalPolicy.md)

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)

# 列出佈建容量 (GET 佈建的容量)
<a name="api-ListProvisionedCapacity"></a>

此作業會列出指定 AWS 帳戶的佈建容量單位。如需佈建之容量的詳細資訊，請參閱「[封存擷取選項](downloading-an-archive-two-steps.md#api-downloading-an-archive-two-steps-retrieval-options)」。

佈建容量單位會持續一個月，從購買的日期和時間開始，即為開始日期。單位會在過期日期當天過期，即開始日期到最接近的秒數的正好一個月。

如果開始日期是在某個月的第 31 天，過期日期則是下個月的最後一天。例如，如果開始日期是 8 月 31 日，過期日期則是 9 月 30 日。如果開始日期是 1 月 31 日，過期日期則是 2 月 28 日。您可以查看 [回應範例](#api-ListProvisionedCapacity-example1-response) 中的此功能。

## 請求語法
<a name="api-ListProvisionedCapacity-RequestSyntax"></a>

若要列出帳戶的佈建擷取容量，請將 HTTP GET 請求傳送到佈建容量 URI，如以下語法範例所示。

```
1. GET /AccountId/provisioned-capacity HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須符合與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID。您可以指定 AWS 帳戶 ID 或選擇性指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

## 請求參數
<a name="api-ListProvisionedCapacity-RequestParameters"></a>

此操作不使用請求參數。

## 請求標頭
<a name="api-ListProvisionedCapacity-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

## 請求主體
<a name="api-ListProvisionedCapacity-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-ListProvisionedCapacity-responses"></a>

如果操作成功，則服務傳回 HTTP `200 OK` 回應。

### 回應語法
<a name="api-ListProvisionedCapacity-ResponseSyntax"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Date: Date
Content-Type: application/json
Content-Length: Length
{
   "ProvisionedCapacityList": 
      {
         "CapacityId" : "string",
         "StartDate" : "string"
         "ExpirationDate" : "string"
      }
}
```

### 回應標頭
<a name="api-ListProvisionedCapacity-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-ListProvisionedCapacity-body"></a>

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

**CapacityId**  <a name="Glacier-ListProvisionedCapacity-response"></a>
此 ID 是用來識別佈建容量單位。  
 *類型*：字串

**StartDate**  
購買佈建容量單位的日期，以國際標準時間 (UTC) 為準。  
*類型*：字串 ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

**ExpirationDate**  
佈建容量單位到期的日期，以國際標準時間 (UTC) 為準。  
*類型*：字串 ISO 8601 日期格式的字串表示法，例如，`2013-03-20T17:03:43.221Z`。

### 錯誤
<a name="api-ListProvisionedCapacity-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-ListProvisionedCapacity-examples"></a>

以下範例列出帳戶的佈建容量單位。

### 範例請求
<a name="api-ListProvisionedCapacity-example1-request"></a>

在這個範例中，傳送 GET 請求以擷取指定帳戶的佈建容量單位的清單。

```
1. GET /123456789012/priority-capacity HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. x-amz-glacier-version: 2012-06-01
5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
```

### 回應範例
<a name="api-ListProvisionedCapacity-example1-response"></a>

如果請求成功，Amazon Glacier (Amazon Glacier) 會傳回 `HTTP 200 OK`，其中包含帳戶的佈建容量單位清單，如下列範例所示。

 第一個列出的佈建容量單位是開始日期為 2017 年 1 月 31 日且過期日期為 2017 年 2 月 28 日的單位範例。如先前所述，如果開始日期是在某個月的第 31 天，過期日期則是下個月的最後一天。

```
 1. HTTP/1.1 200 OK
 2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
 3. Date: Wed, 10 Feb 2017 12:02:00 GMT
 4. Content-Type: application/json
 5. Content-Length: length
 6. 
 7. {
 8.    "ProvisionedCapacityList",
 9.       {
10.          "CapacityId": "zSaq7NzHFQDANTfQkDen4V7z",
11.          "StartDate": "2017-01-31T14:26:33.031Z",
12.          "ExpirationDate": "2017-02-28T14:26:33.000Z",
13.       },
14.       {
15.          "CapacityId": "yXaq7NzHFQNADTfQkDen4V7z",
16.          "StartDate": "2016-12-13T20:11:51.095Z"",
17.          "ExpirationDate": "2017-01-13T20:11:51.000Z" ",
18.       },
19.       ...
20. }
```

## 相關章節
<a name="api-ListProvisionedCapacity-related-sections"></a>

 
+ [購買佈建容量 (POST 佈建的容量)](api-PurchaseProvisionedCapacity.md)

# 購買佈建容量 (POST 佈建的容量)
<a name="api-PurchaseProvisionedCapacity"></a>

這個操作為 AWS 帳戶購買一個佈建容量單位。

佈建容量單位會持續一個月，從購買的日期和時間開始，即為開始日期。單位會在過期日期當天過期，即開始日期到最接近的秒數的正好一個月。

如果開始日期是在某個月的第 31 天，過期日期則是下個月的最後一天。例如，如果開始日期是 8 月 31 日，過期日期則是 9 月 30 日。如果開始日期是 1 月 31 日，過期日期則是 2 月 28 日。

佈建容量有助於確保快速擷取在需要時有可用的擷取容量。容量的每個單位都確保每五分鐘至少可以執行三個快速擷取，並提供最多 150 MB/s 的擷取傳輸量。如需佈建之容量的詳細資訊，請參閱「[封存擷取選項](downloading-an-archive-two-steps.md#api-downloading-an-archive-two-steps-retrieval-options)」。

**注意**  
每個 限制兩個佈建容量單位 AWS 帳戶。

## 要求
<a name="api-PurchaseProvisionedCapacity-requests"></a>

若要購買 的佈建容量單位，請將 HTTP `POST`請求 AWS 帳戶 傳送至佈建容量 URI。

### 語法
<a name="api-PurchaseProvisionedCapacity-requests-syntax"></a>

```
1. POST /AccountId/provisioned-capacity HTTP/1.1
2. Host: glacier.Region.amazonaws.com
3. Date: Date
4. Authorization: SignatureValue
5. Content-Length: Length
6. x-amz-glacier-version: 2012-06-01
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID 相符。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-PurchaseProvisionedCapacity-requestParameters"></a>

#### 請求標頭
<a name="api-PurchaseProvisionedCapacity-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

#### 請求主體
<a name="api-PurchaseProvisionedCapacity-requests-elements"></a>

此操作沒有請求內文。

## 回應
<a name="api-PurchaseProvisionedCapacity-responses"></a>

如果操作請求成功，則服務會傳回 HTTP `201 Created` 回應。

### 語法
<a name="api-PurchaseProvisionedCapacity-response-syntax"></a>

```
HTTP/1.1 201 Created
x-amzn-RequestId: x-amzn-RequestId
Date: Date
x-amz-capacity-id: CapacityId
```

### 回應標頭
<a name="api-PurchaseProvisionedCapacity-responses-headers"></a>

成功的回應除了所有作業通用的回應標頭之外，還包含下列回應標頭。如需常見回應標頭的詳細資訊，請參閱[常見回應標頭](api-common-response-headers.md)。


|  名稱  |  描述 | 
| --- | --- | 
|  `x-amz-capacity-id`   |  此 ID 是用來識別佈建容量單位。 類型：字串  | 

### 回應內文
<a name="api-PurchaseProvisionedCapacity-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-PurchaseProvisionedCapacity-responses-errors"></a>

除了所有 Amazon Glacier 操作常見的可能錯誤之外，此操作還包含下列錯誤。如需 Amazon Glacier 錯誤的資訊和錯誤代碼清單，請參閱 [錯誤回應](api-error-responses.md)。


| Code | Description | HTTP 狀態碼 | Type | 
| --- | --- | --- | --- | 
| LimitExceededException | 如果給定的請求超過帳戶的佈建容量單位的限制，則傳回。 | 400 Bad Request | 用戶端 | 

## 範例
<a name="api-PurchaseProvisionedCapacity-examples"></a>

以下範例購買帳戶的佈建容量。

### 範例請求
<a name="api-PurchaseProvisionedCapacity-example-request"></a>

以下範例傳送 HTTP POST 請求以購買佈建容量單位。

```
1. POST /123456789012/provisioned-capacity HTTP/1.1
2. Host: glacier.us-west-2.amazonaws.com
3. x-amz-Date: 20170210T120000Z
4. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
5. Content-Length: length
6. x-amz-glacier-version: 2012-06-01
```

### 回應範例
<a name="api-PurchaseProvisionedCapacity-example-response"></a>

如果請求成功，Amazon Glacier (Amazon Glacier) 會傳回`HTTP 201 Created`回應，如下列範例所示。

```
1. HTTP/1.1 201 Created
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:02:00 GMT
4. x-amz-capacity-id: zSaq7NzHFQDANTfQkDen4V7z
```

## 相關章節
<a name="api-PurchaseProvisionedCapacity-related-sections"></a>

 
+ [列出佈建容量 (GET 佈建的容量)](api-ListProvisionedCapacity.md)

# 設定資料擷取政策 (PUT 政策)
<a name="api-SetDataRetrievalPolicy"></a>

## 說明
<a name="api-SetDataRetrievalPolicy-description"></a>

此操作會在`PUT`請求中指定的 AWS 區域中設定並制定資料擷取政策。您可以為每個 AWS 區域設定一個政策 AWS 帳戶。政策是在成功的 `PUT` 操作幾分鐘內制定的。

 設定政策操作不會影響擷取任務，其在制定政策之前便已在進行中。如需有關資料擷取政策的詳細資訊，請參閱 [Amazon Glacier 資料擷取政策](data-retrieval-policy.md)。

## 請求
<a name="api-SetDataRetrievalPolicy-requests"></a>

### 語法
<a name="api-SetDataRetrievalPolicy-requests-syntax"></a>

若要設定資料擷取政策，請如以下語法範例所示傳送 HTTP PUT 請求到資料擷取政策 URI。

```
 1. PUT /AccountId/policies/data-retrieval HTTP/1.1
 2. Host: glacier.Region.amazonaws.com
 3. Date: Date
 4. Authorization: SignatureValue
 5. Content-Length: Length
 6. x-amz-glacier-version: 2012-06-01
 7. 			
 8. {
 9.   "Policy":
10.     {
11.       "Rules":[
12.          {
13.              "Strategy": String,
14.              "BytesPerHour": Number          
15.          }
16.        ]
17.     }
18. }
```

 

**注意**  
`AccountId` 值為 AWS 帳戶 ID。此值必須與用來簽署請求的登入資料相關聯的 AWS 帳戶 ID 相符。您可以指定 AWS 帳戶 ID 或選擇性地指定單一 '`-`' （連字號），在這種情況下，Amazon Glacier 會使用與用來簽署請求之登入資料相關聯的 AWS 帳戶 ID。如果您要指定帳戶 ID，請勿在 ID 中包含任何連字號 ('-')。

### 請求參數
<a name="api-SetDataRetrievalPolicy-requests-parameters"></a>

此操作不使用請求參數。

### 請求標頭
<a name="api-SetDataRetrievalPolicy-requests-headers"></a>

此操作僅使用所有操作常見的請求標頭。如需常見請求標頭的資訊，請參閱 [常見請求標題](api-common-request-headers.md)。

### 請求主體
<a name="api-SetDataRetrievalPolicy-requests-elements"></a>

請求內文包含以下 JSON 欄位。

 

**BytesPerHour**  
最多可在一小時內擷取的位元組數。  
此欄位只有在策略欄位的值為 `BytesPerHour` 時才需要。若策略欄位未設定為 `BytesPerHour` 而您設定了此欄位，您的 PUT 操作會被拒絕。  
*類型*：數字  
* 必要*：是，如果策略欄位設定為 `BytesPerHour`。否則為否。  
*有效值*：最低整數值 1。最大整數值為 2^63 - 包含 1。

**規則**  
政策規則。雖然這是清單類型，但目前必須僅有一個規則，其中包含策略欄位和可選的 BytesPerHour 欄位。  
*類型*：陣列  
*必要*：是

**策略**  
要設定的資料擷取政策的類型。  
*類型：*字串  
*必要*：是  
有效值：`BytesPerHour`\$1`FreeTier`\$1`None`。`BytesPerHour` 相當於在主控台中選擇**最大擷取率**。`FreeTier` 相當於在主控台中選擇**僅限免費方案**。`None` 相當於在主控台中選擇**無擷取政策**。如需在主控台中選擇資料擷取政策的詳細資訊，請參閱 [Amazon Glacier 資料擷取政策](data-retrieval-policy.md)。

## 回應
<a name="api-SetDataRetrievalPolicy-responses"></a>

### 語法
<a name="api-SetDataRetrievalPolicyresponse-syntax"></a>

```
HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date
```

### 回應標頭
<a name="api-SetDataRetrievalPolicy-responses-headers"></a>

此操作僅使用大部分回應常見的回應標頭。如需常見回應標頭的資訊，請參閱 [常見回應標頭](api-common-response-headers.md)。

### 回應內文
<a name="api-SetDataRetrievalPolicy-responses-elements"></a>

此作業不會傳回任何回應內文。

### 錯誤
<a name="api-SetDataRetrievalPolicy-responses-errors"></a>

如需 Amazon Glacier 例外狀況和錯誤訊息的相關資訊，請參閱 [錯誤回應](api-error-responses.md)。

## 範例
<a name="api-SetDataRetrievalPolicy-examples"></a>

### 範例請求
<a name="api-SetDataRetrievalPolicy-example-request"></a>

以下範例傳送策略欄位設定為 `BytesPerHour` 的 HTTP PUT 請求。

```
 1. PUT /-/policies/data-retrieval HTTP/1.1
 2. Host: glacier.us-west-2.amazonaws.com
 3. x-amz-Date: 20170210T120000Z
 4. x-amz-glacier-version: 2012-06-01
 5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
 6. 			
 7. {
 8.   "Policy":
 9.     {
10.       "Rules":[
11.          {
12.              "Strategy":"BytesPerHour",
13.              "BytesPerHour":10737418240       
14.           }
15.        ]
16.     }
17. }
```

以下範例傳送策略欄位設定為 `FreeTier` 的 HTTP PUT 請求。

```
 1. PUT /-/policies/data-retrieval HTTP/1.1
 2. Host: glacier.us-west-2.amazonaws.com
 3. x-amz-Date: 20170210T120000Z
 4. x-amz-glacier-version: 2012-06-01
 5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
 6. 			
 7. {
 8.   "Policy":
 9.     {
10.       "Rules":[
11.          {
12.              "Strategy":"FreeTier"   
13.           }
14.        ]
15.     }
16. }
```

以下範例傳送策略欄位設定為 `None` 的 HTTP PUT 請求。

```
 1. PUT /-/policies/data-retrieval HTTP/1.1
 2. Host: glacier.us-west-2.amazonaws.com
 3. x-amz-Date: 20170210T120000Z
 4. x-amz-glacier-version: 2012-06-01
 5. Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2
 6. 			
 7. {
 8.   "Policy":
 9.     {
10.       "Rules":[
11.          {
12.              "Strategy":"None"   
13.           }
14.        ]
15.     }
16. }
```

### 回應範例
<a name="api-SetDataRetrievalPolicy-example-response"></a>

如果請求成功，Amazon Glacier (Amazon Glacier) 會設定政策並傳回 `HTTP 204 No Content`，如下列範例所示。

```
1. HTTP/1.1 204 No Content
2. x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
3. Date: Wed, 10 Feb 2017 12:02:00 GMT
```

## 相關章節
<a name="related-sections-SetDataRetrievalPolicy"></a>

 
+ [取得資料擷取政策 (GET 政策)](api-GetDataRetrievalPolicy.md)

 
+ [啟動任務 (POST 任務)](api-initiate-job-post.md)