Amazon Glacier
开发人员指南 (API 版本 2012-06-01)
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

列出文件库(获取文件库)

描述

此操作会列出调用用户的账户拥有的所有文件库。响应中返回的列表按文件库名称的 ASCII 顺序排序。

默认情况下,每次请求时此操作最多返回 10 个项目。如果有更多文件库要列出,则响应正文中的 marker 字段会包含文件库的Amazon 资源名称 (ARN),新的列出文件库请求会从该名称处继续列表;否则,marker 字段为 null。在下一个“列出文件库”请求中,您可以将 marker 参数设置为 Amazon Glacier 为上一个“列出文件库”请求所回复的值。您也可以通过在请求中指定 limit 参数来限制响应中返回的文件库数。

请求

要获取文件库列表,请向文件库资源发送 GET 请求。

语法

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

注意

AccountId 值为 AWS 账户 ID。此值必须与用来对请求签名的证书相关联的 AWS 账户 ID 相匹配。您可以指定一个 AWS 账户 ID 或者选择指定单一的“-” (连字符),在这种情况下,Amazon Glacier 会使用与用于对请求签名的证书关联的 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) 来表示的上次文件库清单盘点日期。如果文件库中尚未运行清单操作(例如,您刚刚创建了文件库),则此字段可能为空。有关启动文件库清单的信息,请参阅“启动作业(POST 作业)”。

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

Marker

表示从何处继续对结果进行分页的 vaultARN。您可以在另一个列出文件库请求中使用 marker 来获取列表中的更多文件库。如果没有更多文件库,则此值为 null

类型:字符串

NumberOfArchives

截止到上次编制清单日期,文件库中的档案数。

类型:数字

SizeInBytes

截止到上次编制清单日期,文件库中所有档案的总大小(以字节为单位),包括每个档案所具有的任何开销。

类型:数字

VaultARN

文件库的Amazon 资源名称 (ARN)。

类型:字符串

VaultList

数据元数组,其中的每个数据元均提供了文件库描述。

类型:数组

VaultName

文件库名称。

类型:字符串

错误

有关 Amazon Glacier 异常和错误消息的信息,请参阅错误响应

示例

示例:列出所有文件库

以下示例列出了文件库。由于请求中没有指定 markerlimit 参数,因此,系统最多会返回 10 个文件库。

示例请求

GET /-/vaults HTTP/1.1 Host: glacier.us-west-2.amazonaws.com.cn 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

响应示例

Markernull,表示没有更多文件库要列出。

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.cn 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" } ] }