ListObjects

Available in Classic and VPC

Get the list of objects stored in a Ncloud Storage bucket.

Note

We recommend using the latest version, ListObjectsV2 API.

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
`marker`	String	Optional	Query start criteria The `NextMarker` value from the previous response result or a random string can be entered.
`max-keys`	String	Optional	Number of items per page 1-1000
`prefix`	String	Optional	Object name prefix

Request example

The request example is as follows:

GET /?marker=object.csv&max-keys=1 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 Display the input value if `prefix` is entered.
`ListBucketResult.Marker`	String	-	Query start criteria
`ListBucketResult.NextMarker`	String	-	Next query criteria If `IsTruncated` is `true`, enter that value in `marker` of the next request.
`ListBucketResult.MaxKeys`	Integer	-	Number of items per page
`ListBucketResult.IsTruncated`	Boolean	-	Whether next page exists `true` \| `false` `true`: It exists. `false`: It doesn't exist.
`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 ISO 8601 format
`ETag`	String	-	Unique object identifier (entity tag)
`Size`	Integer	-	Object size (byte)
`StorageClass`	String	-	Storage class `STANDARD` \| `DEEP_ARCHIVE` `STANDARD`: Standard Class `DEEP_ARCHIVE`: Archive 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>bucket000</Name>
    <Prefix></Prefix>
    <Marker>object000.csv</Marker>
    <NextMarker>object001.csv</NextMarker>
    <MaxKeys>1</MaxKeys>
    <IsTruncated>true</IsTruncated>
    <Contents>
        <Key>object001.csv</Key>
        <LastModified>2025-04-23T01:55:37Z</LastModified>
        <ETag>&#34;2ecf9f32d97***********39aed87829&#34;</ETag>
        <Size>464</Size>
        <StorageClass>STANDARD</StorageClass>
    </Contents>
</ListBucketResult>