View a markdown version of this page

ListBucket (API SABUN) - Amazon Simple Storage Service
PermintaanRespon SuksesIsi ResponsKontrol Akses

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

ListBucket (API SABUN)

catatan

SOAP API untuk Amazon S3 tidak tersedia untuk pelanggan baru, dan mendekati End of Life (EOL) pada 31 Agustus 2025. Kami menyarankan Anda menggunakan REST API atau AWS SDK.

ListBucketOperasi mengembalikan informasi tentang beberapa item dalam bucket.

Untuk pengenalan umum operasi daftar, lihat Kunci Objek Daftar.

Permintaan

Contoh ini mencantumkan hingga 1000 kunci dalam bucket “tanda kutip” yang memiliki awalan “catatan.”

Sintaks

<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

Nama Deskripsi Diperlukan
prefix

Membatasi respons ke kunci yang dimulai dengan awalan yang ditunjukkan. Anda dapat menggunakan awalan untuk memisahkan bucket menjadi kumpulan kunci yang berbeda dengan cara yang mirip dengan bagaimana sistem file menggunakan folder.

Tipe: String

Default: Tidak Ada

 Tidak
marker

Menunjukkan di mana di bucket untuk memulai daftar. Daftar hanya akan menyertakan kunci yang terjadi secara leksikografis setelah penanda. Ini nyaman untuk paginasi: Untuk mendapatkan halaman hasil berikutnya gunakan kunci terakhir dari halaman saat ini sebagai penanda.

Tipe: String

Default: Tidak Ada

 Tidak
max-keys

Jumlah maksimum kunci yang ingin Anda lihat di badan respons. Server mungkin mengembalikan lebih sedikit dari banyak kunci ini, tetapi tidak akan mengembalikan lebih banyak.

Tipe: String

Default: Tidak Ada

 Tidak
delimiter

Menyebabkan kunci yang berisi string yang sama antara awalan dan kejadian pertama pembatas digulung menjadi elemen hasil tunggal dalam koleksi. CommonPrefixes Kunci yang digulung ini tidak dikembalikan ke tempat lain dalam respons.

Tipe: String

Default: Tidak Ada

 Tidak

Respon Sukses

Respons ini mengasumsikan bucket berisi kunci berikut:

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

Sintaksis

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

Seperti yang Anda lihat, banyak bidang dalam respons menggemakan parameter permintaan. IsTruncated,Contents, dan CommonPrefixes merupakan satu-satunya elemen respons yang dapat berisi informasi baru.

Elemen Respons

Nama Deskripsi
Contents

Metadata tentang setiap objek yang dikembalikan.

Jenis: Metadata XML

Leluhur: ListBucketResult
CommonPrefixes

Respons CommonPrefixes hanya dapat berisi jika Anda menentukan adelimiter. Ketika Anda melakukannya, CommonPrefixes berisi semua (jika ada) kunci antara Prefix dan kejadian berikutnya dari string yang ditentukan olehdelimiter. Akibatnya, CommonPrefixes daftar kunci yang bertindak seperti subdirektori di direktori yang ditentukan olehPrefix. Misalnya, jika prefix adalah notes/ dan delimiter merupakan garis miring (/), innotes/summer/july, awalan umum adalahnotes/summer/.

Tipe: String

Leluhur: ListBucketResult
Delimiter

Menyebabkan kunci yang berisi string yang sama antara awalan dan kejadian pertama pembatas digulung menjadi elemen hasil tunggal dalam koleksi. CommonPrefixes Kunci yang digulung ini tidak dikembalikan ke tempat lain dalam respons.

Tipe: String

Leluhur: ListBucketResult
IsTruncated

Menentukan apakah (benar) atau tidak (salah) semua hasil dikembalikan. Semua hasil mungkin tidak dikembalikan jika jumlah hasil melebihi yang ditentukan olehMaxKeys.

Tipe: String

Leluhur: boolean
Marker

Menunjukkan di mana di bucket untuk memulai daftar.

Tipe: String

Leluhur: ListBucketResult
MaxKeys

Jumlah maksimum kunci yang dikembalikan dalam badan respons.

Tipe: String

Leluhur: ListBucketResult
Name

Nama ember.

Tipe: String

Leluhur: ListBucketResult
Prefix

Tombol yang dimulai dengan awalan yang ditunjukkan.

Tipe: String

Leluhur: ListBucketResult

Isi Respons

Untuk informasi tentang respons daftar, lihat Tanggapan Kunci Listing.

Kontrol Akses

Untuk mencantumkan kunci bucket, Anda harus diberikan READ akses pada bucket.