Available in Classic and VPC
Get the list of objects stored in a Ncloud Storage bucket.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | - |
Request headers
For information about the headers common to all Ncloud Storage APIs, see Ncloud Storage request headers.
Request query parameters
You can use the following query parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
list-type |
Integer | Required | Version classification
|
continuation-token |
String | Optional | Next page query identifier
|
max-keys |
String | Optional | Number of items per page
|
prefix |
String | Optional | Object name prefix |
start-after |
String | Optional | Query start criteria |
Request example
The request example is as follows:
GET /?list-type=2&max-keys=1&start-after=object.csv HTTP/1.1
Host: bucket}.kr.ncloudstorage.com
Response
This section describes the response format.
Response headers
For information about the headers common to all Ncloud Storage APIs, see Ncloud Storage response headers.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
ListBucketResult |
Object | - | Object list query result |
ListBucketResult.Name |
String | - | Bucket name |
ListBucketResult.Prefix |
String | - | Object name prefix |
ListBucketResult.StartAfter |
String | - | Query start criteria |
ListBucketResult.ContinuationToken |
String | - | Page query identifier |
ListBucketResult.NextContinuationToken |
String | - | Next page query identifier
|
ListBucketResult.KeyCount |
Integer | - | Number of response results |
ListBucketResult.MaxKeys |
Integer | - | Number of items per page |
ListBucketResult.IsTruncated |
Boolean | - | Whether next page exists
|
ListBucketResult.Contents |
Array | - | Object list |
Contents
The following describes Contents
.
Field | Type | Required | Description |
---|---|---|---|
Key |
String | - | Object name |
LastModified |
String | - | Last modification date and time
|
ETag |
String | - | Unique object identifier (entity tag) |
Size |
Integer | - | Object size (byte) |
StorageClass |
String | - | Storage class
|
Response status codes
For information about the HTTP status codes common to all Ncloud Storage APIs, see Common Ncloud Storage response status codes.
Response example
The response example is as follows:
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
<Name>bucket</Name>
<Prefix></Prefix>
<StartAfter>object.csv</StartAfter>
<NextContinuationToken>bGlicmFyeV**********b3B5LmNzdg==</NextContinuationToken>
<KeyCount>1</KeyCount>
<MaxKeys>1</MaxKeys>
<IsTruncated>true</IsTruncated>
<Contents>
<Key>object.csv</Key>
<LastModified>2025-04-23T01:55:37Z</LastModified>
<ETag>"2ecf9f32d97***********39aed87829"</ETag>
<Size>464</Size>
<StorageClass>STANDARD</StorageClass>
</Contents>
</ListBucketResult>