View a markdown version of this page

ListBucket (SOAP-API) - Amazon Simple Storage Service
AnforderungenAntwort: ErfolgAntworttextZugriffskontrolle

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

ListBucket (SOAP-API)

Anmerkung

SOAP APIs für Amazon S3 sind für Neukunden nicht verfügbar und nähern sich am 31. August 2025 dem Ende des Lebenszyklus (EOL). Wir empfehlen, entweder die REST-API oder die AWS SDKs zu verwenden.

Der ListBucket Vorgang gibt Informationen zu einigen Elementen im Bucket zurück.

Eine allgemeine Einführung in den Listenvorgang finden Sie unter Objektschlüssel auflisten.

Anforderungen

In diesem Beispiel werden bis zu 1000 Schlüssel im Bucket „Anführungszeichen“ aufgeführt, die das Präfix „notes“ haben.

Syntax

<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>

Parameter

Name Description Erforderlich
prefix

Beschränkt die Antwort auf Schlüssel, die mit dem angegebenen Präfix beginnen. Sie können Präfixe verwenden, um einen Bucket in verschiedene Schlüsselsätze zu unterteilen, ähnlich wie ein Dateisystem Ordner verwendet.

Typ: Zeichenfolge

Standard: keiner

 Nein
marker

Gibt an, an welcher Stelle im Bucket mit der Auflistung begonnen werden soll. Die Liste enthält nur Schlüssel, die lexikografisch hinter der Markierung vorkommen. Das ist praktisch für die Seitennummerierung: Um zur nächsten Ergebnisseite zu gelangen, verwenden Sie den letzten Schlüssel der aktuellen Seite als Markierung.

Typ: Zeichenfolge

Standard: keiner

 Nein
max-keys

Die maximale Anzahl von Schlüsseln, die Sie im Antworttext sehen möchten. Der Server gibt möglicherweise weniger als so viele Schlüssel zurück, aber nicht mehr.

Typ: Zeichenfolge

Standard: keiner

 Nein
delimiter

Bewirkt, dass Schlüssel, die dieselbe Zeichenfolge zwischen dem Präfix und dem ersten Vorkommen des Trennzeichens enthalten, zu einem einzigen Ergebniselement in der CommonPrefixes Auflistung zusammengefasst werden. Diese zusammengefassten Schlüssel werden an keiner anderen Stelle in der Antwort zurückgegeben.

Typ: Zeichenfolge

Standard: keiner

 Nein

Antwort: Erfolg

Bei dieser Antwort wird davon ausgegangen, dass der Bucket die folgenden Schlüssel enthält:

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

Syntax

<?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>

Wie Sie sehen können, geben viele Felder in der Antwort die Anforderungsparameter wieder. IsTruncatedContents, und CommonPrefixes sind die einzigen Antwortelemente, die neue Informationen enthalten können.

Antwortelemente

Name Description
Contents

Metadaten zu jedem zurückgegebenen Objekt.

Typ: XML-Metadaten

Vorfahr: ListBucketResult
CommonPrefixes

Eine Antwort kann CommonPrefixes nur enthalten, wenn Sie eine delimiter angeben. Wenn Sie dies tun, CommonPrefixes enthält sie alle Schlüssel (falls es welche gibt) zwischen Prefix und dem nächsten Vorkommen der Zeichenfolge, die durch angegeben istdelimiter. CommonPrefixesListet tatsächlich Schlüssel auf, die sich wie Unterverzeichnisse in dem von Prefix angegebenen Verzeichnis verhalten. Wenn beispielsweise ein Schrägstrich (/) prefix delimiter ist notes/ und ein Schrägstrich (/) ist, ist in notes/summer/july das allgemeine Präfix. notes/summer/

Typ: Zeichenfolge

Vorfahr: ListBucketResult
Delimiter

Bewirkt, dass Schlüssel, die dieselbe Zeichenfolge zwischen dem Präfix und dem ersten Vorkommen des Trennzeichens enthalten, zu einem einzigen Ergebniselement in der Sammlung zusammengefasst werden. CommonPrefixes Diese zusammengefassten Schlüssel werden an keiner anderen Stelle in der Antwort zurückgegeben.

Typ: Zeichenfolge

Vorfahr: ListBucketResult
IsTruncated

Gibt an, ob (wahr) oder nicht (falsch) alle Ergebnisse zurückgegeben wurden. Es werden möglicherweise nicht alle Ergebnisse zurückgegeben, wenn die Anzahl der Ergebnisse die angegebene Anzahl von überschreitetMaxKeys.

Typ: Zeichenfolge

Vorfahr: boolesch
Marker

Gibt an, an welcher Stelle im Bucket mit dem Listing begonnen werden soll.

Typ: Zeichenfolge

Vorfahr: ListBucketResult
MaxKeys

Die maximale Anzahl von Schlüsseln, die im Antworttext zurückgegeben werden.

Typ: Zeichenfolge

Vorfahr: ListBucketResult
Name

Name des Eimers.

Typ: Zeichenfolge

Vorfahr: ListBucketResult
Prefix

Schlüssel, die mit dem angegebenen Präfix beginnen.

Typ: Zeichenfolge

Vorfahr: ListBucketResult

Antworttext

Informationen zur Listenantwort finden Sie unter Listing Keys Response.

Zugriffskontrolle

Um die Schlüssel eines Buckets aufzulisten, müssen Sie READ Zugriff auf den Bucket erhalten haben.