View a markdown version of this page

ListBucket (API SOAP) - Amazon Simple Storage Service
RequêtesRéponse réussieCorps de la réponseContrôle d’accès

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.

ListBucket (API SOAP)

Note

Les SOAP API pour Amazon S3 ne sont pas disponibles pour les nouveaux clients. Leur fin de vie est prévue le 31 août 2025. Nous vous recommandons d'utiliser l'API REST ou les AWS SDK.

L'ListBucketopération renvoie des informations sur certains éléments du compartiment.

Pour une présentation générale du fonctionnement de la liste, consultez la section Clés des objets de liste.

Requêtes

Cet exemple répertorie jusqu'à 1 000 clés dans le compartiment « guillemets » qui ont le préfixe « notes ».

Syntaxe

<ListBucket xmlns="https://doc.s3.amazonaws.com/2006-03-01">
  <Bucket>quotes</Bucket>
  <Prefix>notes/</Prefix>
  <Delimiter>/</Delimiter>
  <MaxKeys>1000</MaxKeys>
  <AWSAccessKeyId>AKIAIOSFODNN7EXAMPLE</AWSAccessKeyId>
  <Timestamp>2006-03-01T12:00:00.183Z</Timestamp>
  <Signature>Iuyz3d3P0aTou39dzbqaEXAMPLE=</Signature>
</ListBucket>

Paramètres

Nom Description Obligatoire
prefix

Limite la réponse aux touches commençant par le préfixe indiqué. Vous pouvez utiliser des préfixes pour séparer un compartiment en différents ensembles de clés de la même manière qu'un système de fichiers utilise les dossiers.

Type : Chaîne

Par défaut : aucun

 Non
marker

Indique où commencer la mise en vente dans le compartiment. La liste inclura uniquement les clés qui apparaissent lexicographiquement après le marqueur. C'est pratique pour la pagination : pour obtenir la page de résultats suivante, utilisez la dernière touche de la page en cours comme marqueur.

Type : Chaîne

Par défaut : aucun

 Non
max-keys

Le nombre maximum de touches que vous souhaitez voir apparaître dans le corps de la réponse. Le serveur peut renvoyer un nombre inférieur à ce nombre de clés, mais il n'en renverra pas plus.

Type : Chaîne

Par défaut : aucun

 Non
delimiter

Fait en sorte que les clés contenant la même chaîne entre le préfixe et la première occurrence du délimiteur soient regroupées en un seul élément de résultat de la CommonPrefixes collection. Ces clés enroulées ne sont pas renvoyées ailleurs dans la réponse.

Type : Chaîne

Par défaut : aucun

 Non

Réponse réussie

Cette réponse suppose que le compartiment contient les clés suivantes :

notes/todos.txt
notes/2005-05-23/customer_mtg_notes.txt
notes/2005-05-23/phone_notes.txt
notes/2005-05-28/sales_notes.txt

Syntaxe

<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Name>backups</Name>
  <Prefix>notes/</Prefix>
  <MaxKeys>1000</MaxKeys>
  <Delimiter>/</Delimiter>
  <IsTruncated>false</IsTruncated>
  <Contents>
    <Key>notes/todos.txt</Key>
    <LastModified>2006-01-01T12:00:00.000Z</LastModified>
    <ETag>&quot;828ef3fdfa96f00ad9f27c383fc9ac7f&quot;</ETag>
    <Size>5126</Size>
    <StorageClass>STANDARD</StorageClass>
    <Owner>
      <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>
      <DisplayName>webfile</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
  </Contents>
  <CommonPrefixes>
    <Prefix>notes/2005-05-23/</Prefix>
  </CommonPrefixes>
  <CommonPrefixes>
    <Prefix>notes/2005-05-28/</Prefix>
  </CommonPrefixes>
  </ListBucketResult>

Comme vous pouvez le constater, de nombreux champs de la réponse font écho aux paramètres de la demande. IsTruncatedContents, et CommonPrefixes sont les seuls éléments de réponse qui peuvent contenir de nouvelles informations.

Éléments de réponse

Nom Description
Contents

Métadonnées relatives à chaque objet renvoyé.

Type : métadonnées XML

Ancêtre : ListBucketResult
CommonPrefixes

Une réponse ne peut contenir CommonPrefixes que si vous spécifiez undelimiter. Lorsque vous le faites, CommonPrefixes contient toutes les clés (le cas échéant) comprises entre Prefix la prochaine occurrence de la chaîne spécifiée pardelimiter. En fait, CommonPrefixes répertorie les clés qui agissent comme des sous-répertoires dans le répertoire spécifié parPrefix. Par exemple, si prefix est notes/ et delimiter est une barre oblique (/), dansnotes/summer/july, le préfixe commun est. notes/summer/

Type : Chaîne

Ancêtre : ListBucketResult
Delimiter

Fait en sorte que les clés contenant la même chaîne entre le préfixe et la première occurrence du délimiteur soient regroupées en un seul élément de résultat de la CommonPrefixes collection. Ces clés enroulées ne sont pas renvoyées ailleurs dans la réponse.

Type : Chaîne

Ancêtre : ListBucketResult
IsTruncated

Spécifie si (vrai) ou non (faux) tous les résultats ont été renvoyés. Tous les résultats peuvent ne pas être renvoyés si le nombre de résultats dépasse celui spécifié parMaxKeys.

Type : Chaîne

Ancêtre : booléen
Marker

Indique où commencer la mise en vente dans le compartiment.

Type : Chaîne

Ancêtre : ListBucketResult
MaxKeys

Le nombre maximum de clés renvoyées dans le corps de la réponse.

Type : Chaîne

Ancêtre : ListBucketResult
Name

Nom du seau.

Type : Chaîne

Ancêtre : ListBucketResult
Prefix

Clés commençant par le préfixe indiqué.

Type : Chaîne

Ancêtre : ListBucketResult

Corps de la réponse

Pour plus d'informations sur la réponse de la liste, voir Listing Keys Response.

Contrôle d’accès

Pour répertorier les clés d'un compartiment, vous devez avoir obtenu l'autorisation d'READy accéder.