「列出文件庫」(GET 文件庫)

描述

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

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

請求

若要取得文件庫清單，請向GET文件庫 資源傳送 請求。

語法

GET /AccountId/vaults HTTP/1.1
Host: glacier.Region.amazonaws.com
Date: Date
Authorization: SignatureValue
x-amz-glacier-version: 2012-06-01

注意

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

請求參數

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

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

請求標頭

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

請求主體

此操作沒有請求內文。

回應

語法

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
   }, 
   ...
  ]
}

回應標頭

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

回應內文

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

CreationDate

建立文件庫的日期，以國際標準時間 (UTC) 為準。

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

LastInventoryDate

上次文件庫庫存的日期，以國際標準時間 (UTC) 為準。如果文件庫尚未執行庫存，此欄位可以為 null，例如，您剛剛建立文件庫。如需有關啟動文件庫之庫存的詳細資訊，請參閱 啟動任務 (POST 任務)。

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

Marker

vaultARN 代表繼續分頁結果。您在另一個「列出文件庫」請求中使用 marker 來取得清單中的更多文件庫。如果沒有更多的文件庫，則此值為 null。

類型：字串

NumberOfArchives

截至上次庫存日期的文件庫中的封存數量。

類型：數字

SizeInBytes

文件庫中的所有封存大小總計以位元組為單位，包括截至最後一個庫存日期的各封存成本。

類型：數字

VaultARN

文件庫的 Amazon Resource Name (ARN)。

類型：字串

VaultList

物件陣列，每個物件提供文件庫的說明。

類型：陣列

VaultName

此文件庫名稱。

類型：字串

錯誤

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

範例

範例：列出所有文件庫

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

範例請求

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

回應範例

Marker 是 null 表明沒有更多的文件庫列出。

HTTP/1.1 200 OK
x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
Date: Wed, 10 Feb 2017 12:02:00 GMT
Content-Type: application/json
Content-Length: 497	

{
  "Marker": null,
  "VaultList": [ 
   {
    "CreationDate": "2012-03-16T22:22:47.214Z",
    "LastInventoryDate": "2012-03-21T22:06:51.218Z",
    "NumberOfArchives": 2,
    "SizeInBytes": 12334,
    "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault1",
    "VaultName": "examplevault1"
   }, 
   {
    "CreationDate": "2012-03-19T22:06:51.218Z",
    "LastInventoryDate": "2012-03-21T22:06:51.218Z",
    "NumberOfArchives": 0,
    "SizeInBytes": 0,
    "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault2",
    "VaultName": "examplevault2"
   },
   {
    "CreationDate": "2012-03-19T22:06:51.218Z",
    "LastInventoryDate": "2012-03-25T12:14:31.121Z",
    "NumberOfArchives": 0,
    "SizeInBytes": 0,
    "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault3",
    "VaultName": "examplevault3"
   } 
  ]
}

範例：部分文件庫清單

以下範例傳回從 marker 指定的文件庫開始的兩個文件庫。

範例請求

GET /-/vaults?limit=2&marker=arn:aws:glacier:us-west-2:012345678901:vaults/examplevault1 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	

回應範例

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

HTTP/1.1 200 OK
x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
Date: Wed, 10 Feb 2017 12:02:00 GMT
Content-Type: application/json
Content-Length: 497	

{
  "Marker": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault3",
  "VaultList": [ 
   {
    "CreationDate": "2012-03-16T22:22:47.214Z",
    "LastInventoryDate": "2012-03-21T22:06:51.218Z",
    "NumberOfArchives": 2,
    "SizeInBytes": 12334,
    "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault1",
    "VaultName": "examplevault1"
   }, 
   {
    "CreationDate": "2012-03-19T22:06:51.218Z",
    "LastInventoryDate": "2012-03-21T22:06:51.218Z",
    "NumberOfArchives": 0,
    "SizeInBytes": 0,
    "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault2",
    "VaultName": "examplevault2"
   }
  ]
}

相關章節

• 建立文件庫 (PUT 文件庫)

• 刪除文件庫 (DELETE 文件庫)

• 啟動任務 (POST 任務)

• Amazon S3 Glacier 的 Identity and Access Management

另請參閱

如需在語言特定的 Amazon 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：

• AWS Command Line Interface