Affichage des coffres (GET vaults) - Amazon S3 Glacier
DescriptionRequêtesRéponsesExemplesSections connexesVoir aussi

Cette page s'adresse uniquement aux clients existants du service S3 Glacier utilisant Vaults et l'API REST d'origine datant de 2012.

Si vous recherchez des solutions de stockage d'archives, nous vous conseillons d'utiliser les classes de stockage S3 Glacier dans Amazon S3, S3 Glacier Instant Retrieval, S3 Glacier Flexible Retrieval et S3 Glacier Deep Archive. Pour en savoir plus sur ces options de stockage, consultez les sections Classes de stockage S3 Glacier et Stockage de données à long terme à l'aide des classes de stockage S3 Glacier dans le guide de l'utilisateur Amazon S3. Ces classes de stockage utilisent l'API Amazon S3, sont disponibles dans toutes les régions et peuvent être gérées au sein de la console Amazon S3. Ils offrent des fonctionnalités telles que l'analyse des coûts de stockage, Storage Lens, des fonctionnalités de sécurité, notamment de multiples options de cryptage, etc.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Affichage des coffres (GET vaults)

Description

Cette opération affiche la liste de tous les coffres dont le compte de l'utilisateur appelant est propriétaire. La liste renvoyée dans la réponse est triée en fonction des valeurs ASCII des noms de coffre.

Par défaut, cette opération renvoie jusqu'à 10 éléments par demande. S'il existe d'autres coffres à afficher, le champ marker du corps de la réponse contient l'Amazon Resource Name (ARN) du coffre à partir duquel poursuivre l'affichage de la liste avec une nouvelle demande d'affichage des coffres ; sinon, la valeur du champ marker est null. Dans votre prochaine demande d'obtention de la liste des coffres, vous définissez le paramètre marker sur la valeur renvoyée par Amazon S3 Glacier (S3 Glacier) dans les réponses à votre précédente demande d'obtention de la liste des coffres. Vous pouvez également limiter le nombre de coffres renvoyés dans la réponse en spécifiant le paramètre limit dans la demande.

Requêtes

Pour obtenir une liste de coffres, vous envoyez une demande GET à la ressource vaults.

Syntaxe

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

Note

La valeur de AccountId est l'ID de Compte AWS. Cette valeur doit correspondre à l'ID de Compte AWS associé aux informations d'identification utilisées pour signer la demande. Vous pouvez spécifier un ID de Compte AWS ou éventuellement un simple « - » (trait d'union), auquel cas Amazon S3 Glacier utilise l'ID de Compte AWS associé aux informations d'identification utilisées pour signer la demande. Si vous spécifiez votre ID de compte, n'incluez pas de traits d'union (« - ») dans l'ID.

Paramètres de demande

Cette opération utilise les paramètres de demande suivants.

Name (Nom) Description Obligatoire
limit

Le nombre maximum de coffres à renvoyer. La limite par défaut est de 10. Il peut arriver que le nombre de coffres renvoyés soit inférieur à la limite spécifiée, mais il ne sera jamais supérieur à cette valeur.

Type : chaîne

Contraintes : la valeur d'entier minimale est 1. La valeur d'entier maximale est 10.

 Non
marker

Chaîne opaque utilisée pour la pagination. marker spécifie l'ARN du coffre à partir duquel l'affichage de la liste de coffres doit débuter. (Le coffre spécifié pour le paramètre marker n'est pas inclus dans la liste renvoyée.) Obtenez la valeur du paramètre marker à partir d'une réponse à une demande d'affichage des coffres précédente. Vous ne devez inclure la valeur du paramètre marker que si vous poursuivez la pagination de résultats commencée dans une demande d'affichage des coffres précédente. Si une valeur vide ("") est spécifiée pour le paramètre marker, la liste de coffres renvoyée débute à partir du premier coffre.

Type : chaîne

Contraintes: Aucune

 Non

En-têtes de demande

Cette opération utilise uniquement les en-têtes de demande qui sont communs à toutes les opérations. Pour plus d'informations sur les en-têtes de demande communs, consultez En-têtes de demande communs.

Corps de la requête

Cette opération n'a pas de corps de demande.

Réponses

Syntaxe

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

En-têtes de réponse

Cette opération utilise uniquement les en-têtes de réponse qui sont communs à la plupart des réponses. Pour plus d'informations sur les en-têtes de réponse communs, consultez En-têtes de réponse communs.

Corps de la réponse

Le corps de la réponse contient les champs JSON suivants.

CreationDate

Date à laquelle le coffre a été créé, exprimée en heure UTC (temps universel coordonné).

Type : chaîne. Représentation sous forme de chaîne au format de date ISO 8601, par exemple 2013-03-20T17:03:43.221Z.

LastInventoryDate

Date du dernier inventaire du coffre, exprimée en heure UTC (temps universel coordonné). Ce champ peut avoir une valeur null si un inventaire n'a pas encore été exécuté sur le coffre, par exemple, si celui-ci vient d'être créé. Pour plus d'informations sur le lancement d'un inventaire pour un coffre, consultez la section Lancement d'une tâche (POST jobs).

Type : représentation sous forme de chaîne au format de date ISO 8601, par exemple 2013-03-20T17:03:43.221Z.

Marker

Champ vaultARN représentant l'endroit à partir duquel poursuivre la pagination des résultats. Vous utilisez la valeur du paramètre marker dans une autre demande d'affichage des coffres pour obtenir davantage de coffres dans la liste. S'il n'y a pas d'autres coffres, cette valeur est null.

Type : chaîne

NumberOfArchives

Nombre d'archives présentes dans le coffre à la date du dernier inventaire.

Type : nombre

SizeInBytes

Taille totale, exprimée en octets, de toutes les archives présentes dans le coffre, y compris l'éventuelle surcharge de chaque archive, à la date du dernier inventaire.

Type : nombre

VaultARN

Amazon Resource Name (ARN) du coffre.

Type : chaîne

VaultList

Tableau d'objets, chacun d'eux fournissant une description d'un coffre.

Type : tableau

VaultName

Nom du coffre.

Type : chaîne

Erreurs

Pour en savoir plus sur les exceptions et les messages d'erreur Amazon S3 Glacier, consultez Réponses d'erreur.

Exemples

Exemple : Affichage de la liste de tous les coffres

L'exemple suivant affiche la liste des coffres. Dans la mesure où les paramètres marker et limit ne sont pas spécifiés dans la demande, jusqu'à 10 coffres peuvent être renvoyés.

Exemple de requête

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

Exemple de réponse

La valeur du champ Marker est null, ce qui signifie qu'il n'y a pas d'autres coffres à afficher.

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

Exemple : Affichage d'une liste partielle de coffres

L'exemple suivant renvoie deux coffres à partir du coffre spécifié par le paramètre marker.

Exemple de requête

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

Exemple de réponse

Deux coffres sont renvoyés dans la liste. Le champ Marker contient l'ARN de coffre à utiliser afin de poursuivre la pagination dans une autre demande d'affichage des coffres.

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

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK Amazon propres au langage, consultez la ressource suivante :