Enumeración de almacenes (GET almacenes) - Amazon S3 Glacier

Si aún no se ha familiarizado con el almacenamiento de archivos en Amazon Simple Storage Service (Amazon S3), se recomienda que comience por obtener más información sobre las clases de almacenamiento de S3 Glacier en Amazon S3, S3 Glacier Instant Retrieval, S3 Glacier Flexible Retrieval y S3 Glacier Deep Archive. Para obtener más información, consulte Clases de almacenamiento de S3 Glacier y Clases de almacenamiento para archivar objetos en la Guía del usuario de Amazon S3.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Enumeración de almacenes (GET almacenes)

Descripción

Esta operación enumera todos los almacenes que sean propiedad de la cuenta del usuario que hace la llamada. La lista que se devuelve en la respuesta ordenada en ASCII por nombre de almacén.

De forma predeterminada, esta operación devuelve un máximo de 10 elementos por solicitud. Si no hay más almacenes para mostrar, el campo marker del cuerpo de la respuesta contiene el nombre de recurso de Amazon (ARN) del almacén en el que continuará la lista cuando se envíe una nueva solicitud de enumeración de almacenes; de lo contrario, el campo marker es null. En la siguiente solicitud de enumeración de almacenes se establece el parámetro marker en el valor que Amazon S3 Glacier (S3 Glacier) devolvió en las respuestas a su solicitud anterior de enumeración de almacenes. También puede limitar el número de almacenes devueltos en la respuesta especificando el parámetro limit en la solicitud.

Solicitudes

Para obtener una lista de almacenes, envíe una solicitud GET al recurso vaults.

Sintaxis

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

nota

El valor AccountId es el ID de Cuenta de AWS. Este valor debe coincidir con el ID de la Cuenta de AWS asociada con las credenciales que se utilizaron para firmar la solicitud. Puede especificar un ID de Cuenta de AWS o, si lo desea, un solo carácter “-” (guion), en cuyo caso, Amazon S3 Glacier usa el ID de la Cuenta de AWS asociada con las credenciales empleadas para firmar la solicitud. Si especifica su ID de cuenta, no incluya ningún guion (“-”) en él.

Parámetros de solicitud

Esta operación usa los siguientes parámetros de solicitud.

Nombre Descripción Obligatorio
limit

Número máximo de almacenes que se van a devolver. El límite predeterminado es 10. El número de almacenes devueltos puede ser menor que el límite especificado, pero nunca puede superarlo.

Tipo: String

Restricciones: el valor entero mínimo es 1. El valor entero máximo es 10.

No
marker

Una cadena utilizada para la paginación. marker especifica el ARN del almacén después del que debe empezar la lista de almacenes. (El almacén especificado por marker no está incluido en la lista devuelta). El valor de marker se obtiene de una respuesta anterior de enumeración de almacenes. Tiene que incluir marker únicamente si quiere continuar la paginación de resultados que se inició en una solicitud anterior de enumeración de almacenes. La especificación de un valor vacío ("") para el marcador devuelve una lista de almacenes a partir del primer almacén.

Tipo: String

Restricciones: ninguna

No

Encabezados de solicitud

Esta operación solo usa encabezados de solicitud que sean comunes para todas las operaciones. Para obtener información acerca de los encabezados de solicitudes comunes, consulte Encabezados de solicitudes comunes.

Cuerpo de la solicitud

Esta operación no tiene un cuerpo de la solicitud.

Respuestas

Sintaxis

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

Encabezados de respuesta

Esta operación solo usa encabezados de respuesta que sean comunes a la mayoría de las respuestas. Para obtener información acerca de los encabezados de respuestas comunes, consulte Encabezados de respuesta comunes.

Cuerpo de respuesta

El cuerpo de la respuesta contiene los siguientes campos JSON.

CreationDate

La fecha en que se creó el almacén, en UTC (hora universal coordinada).

Tipo: cadena. Una representación de cadena con el formato de fecha ISO 8601; por ejemplo, 2013-03-20T17:03:43.221Z.

LastInventoryDate

La fecha del último inventario de almacén, en UTC (hora universal coordinada). Este campo puede ser nulo si aún no se ha ejecutado un inventario del almacén; por ejemplo, si se acaba de crear el almacén. Para obtener información acerca de cómo iniciar un inventario de un almacén, consulte Inicialización de trabajos (POST trabajos).

Tipo: una representación de cadena con el formato de fecha ISO 8601; por ejemplo, 2013-03-20T17:03:43.221Z.

Marker

vaultARN indica dónde se va a continuar la paginación de los resultados. Puede utilizar marker en otra solicitud de enumeración de almacenes para obtener más almacenes en la lista. Si no hay más almacenes, este valor es null.

Tipo: cadena

NumberOfArchives

Número de archivos del almacén desde la última fecha de inventario.

Tipo: Número

SizeInBytes

Tamaño total, en bytes, de todos los archivos del almacén, incluidas las sobrecargas de cada archivo, desde la fecha del último inventario.

Tipo: Número

VaultARN

Nombre de recurso de Amazon (ARN) del almacén.

Tipo: cadena

VaultList

Una matriz de objetos, donde cada objeto ofrece una descripción de un almacén.

Tipo: Array

VaultName

El nombre del almacén.

Tipo: cadena

Errores

Para obtener información acerca de los mensajes de error y las excepciones de Amazon S3 Glacier, consulte Respuestas de error.

Ejemplos

Ejemplo: enumerar todos los almacenes

En el siguiente ejemplo se enumeran los almacenes. Como los parámetros marker y limit no están especificados en la solicitud, se devolverán, como máximo, 10 cargas almacenes.

Solicitud de ejemplo

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

Respuesta de ejemplo

El valor de Marker es null, lo que indica no hay más almacenes para enumerar.

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

Ejemplo: lista parcial de almacenes

El siguiente ejemplo devuelve dos almacenes desde el almacén especificado por marker.

Solicitud de ejemplo

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

Respuesta de ejemplo

Se devuelven dos almacenes en la lista. Marker contiene el ARN de almacén para continuar la paginación en otra solicitud de enumeración de almacenes.

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

Véase también

Para obtener más información sobre el uso de esta API en uno de los SDK de Amazon específicos de idioma, consulte lo siguiente: