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

# ListBucket (API SABUN)
<a name="SOAPListBucket"></a>

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

 `ListBucket`Operasi mengembalikan informasi tentang beberapa item dalam bucket. 

 Untuk pengenalan umum operasi daftar, lihat Kunci [ Objek Daftar](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html).

## Permintaan
<a name="SOAPBucketGET_Request"></a>

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

### Sintaks
<a name="SOAPBucketGET_RequestSyntax"></a>

```
1. <ListBucket xmlns="https://doc.s3.amazonaws.com/2006-03-01">
2.   <Bucket>quotes</Bucket>
3.   <Prefix>notes/</Prefix>
4.   <Delimiter>/</Delimiter>
5.   <MaxKeys>1000</MaxKeys>
6.   <AWSAccessKeyId>AKIAIOSFODNN7EXAMPLE</AWSAccessKeyId>
7.   <Timestamp>2006-03-01T12:00:00.183Z</Timestamp>
8.   <Signature>Iuyz3d3P0aTou39dzbqaEXAMPLE=</Signature>
9. </ListBucket>
```

### Parameter
<a name="SOAPBucketGET_RequestHeaders"></a>


|  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.<br />Tipe: String<br />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.<br />Tipe: String<br />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.<br />Tipe: String<br />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.<br />Tipe: String<br />Default: Tidak Ada |  Tidak  | 

## Respon Sukses
<a name="SOAPBucketGET_ResponseSuccess"></a>

Respons ini mengasumsikan bucket berisi kunci berikut:

```
1. notes/todos.txt
2. notes/2005-05-23/customer_mtg_notes.txt
3. notes/2005-05-23/phone_notes.txt
4. notes/2005-05-28/sales_notes.txt
```

### Sintaksis
<a name="SOAPBucketGET_ResponseSuccess-syntax"></a>

```
 1. <?xml version="1.0" encoding="UTF-8"?>
 2. <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
 3.   <Name>backups</Name>
 4.   <Prefix>notes/</Prefix>
 5.   <MaxKeys>1000</MaxKeys>
 6.   <Delimiter>/</Delimiter>
 7.   <IsTruncated>false</IsTruncated>
 8.   <Contents>
 9.     <Key>notes/todos.txt</Key>
10.     <LastModified>2006-01-01T12:00:00.000Z</LastModified>
11.     <ETag>&quot;828ef3fdfa96f00ad9f27c383fc9ac7f&quot;</ETag>
12.     <Size>5126</Size>
13.     <StorageClass>STANDARD</StorageClass>
14.     <Owner>
15.       <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>
16.       <DisplayName>webfile</DisplayName>
17.     </Owner>
18.     <StorageClass>STANDARD</StorageClass>
19.   </Contents>
20.   <CommonPrefixes>
21.     <Prefix>notes/2005-05-23/</Prefix>
22.   </CommonPrefixes>
23.   <CommonPrefixes>
24.     <Prefix>notes/2005-05-28/</Prefix>
25.   </CommonPrefixes>
26.   </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
<a name="SOAPBucketGET_ResponseSuccess-response-elements"></a>


|  Nama  |  Deskripsi  | 
| --- | --- | 
|  Contents  | Metadata tentang setiap objek yang dikembalikan.<br />Jenis: Metadata XML<br />Leluhur: ListBucketResult | 
|  CommonPrefixes  |  Respons `CommonPrefixes` hanya dapat berisi jika Anda menentukan a`delimiter`. Ketika Anda melakukannya, `CommonPrefixes` berisi semua (jika ada) kunci antara `Prefix` dan kejadian berikutnya dari string yang ditentukan oleh`delimiter`. Akibatnya, `CommonPrefixes` daftar kunci yang bertindak seperti subdirektori di direktori yang ditentukan oleh`Prefix`. Misalnya, jika `prefix` adalah `notes/` dan `delimiter` merupakan garis miring (/), in`notes/summer/july`, awalan umum adalah`notes/summer/`. <br />Tipe: String<br />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.<br />Tipe: String<br />Leluhur: ListBucketResult | 
|  IsTruncated  | Menentukan apakah (benar) atau tidak (salah) semua hasil dikembalikan. Semua hasil mungkin tidak dikembalikan jika jumlah hasil melebihi yang ditentukan oleh`MaxKeys`.<br />Tipe: String<br />Leluhur: boolean | 
|  Marker  | Menunjukkan di mana di bucket untuk memulai daftar.<br />Tipe: String<br />Leluhur: ListBucketResult | 
|  MaxKeys  | Jumlah maksimum kunci yang dikembalikan dalam badan respons.<br />Tipe: String<br />Leluhur: ListBucketResult | 
|  Name  | Nama ember.<br />Tipe: String<br />Leluhur: ListBucketResult | 
|  Prefix  | Tombol yang dimulai dengan awalan yang ditunjukkan.<br />Tipe: String<br />Leluhur: ListBucketResult | 

## Isi Respons
<a name="SOAPListBucketResponseBody"></a>

 Untuk informasi tentang respons daftar, lihat Tanggapan [ Kunci Listing](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html). 

## Kontrol Akses
<a name="SOAPListBucketAccessControl"></a>

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