ListObjects

Available in Classic and VPC

View the object list of Object Storage. No request body is used for the operation.

Note

The number of objects retrieved at a time is limited to 1000 and are returned in random order.
If the StorageClass operation is not implemented in NAVER Cloud Platform Object Storage, the value of StorageClass returned in the response code is the default value.

Requests

The following describes the request format for the endpoint. The request format is as follows.

Method	URI
GET	{bucket-name}

Request syntax

GET https://{endpoint}/{bucket-name} # path style
GET https://{bucket-name}.{endpoint} # virtual host style

Request headers

For headers common to all Object Storage APIs, see Object Storage common headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`bucket-name`	String	Required	Bucket to create

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`prefix`	String	Optional	Limit the response to object names starting with the prefix
`delimiter`	String	Optional	Criteria for binding objects Bind the objects between the prefix and delimiter together
`encoding-type`	String	Optional	Encoding type Resolve encoding issues by setting the parameter to URL if Unicode characters not supported by XML are used in the object name
`max-keys`	String	Optional	Number of objects to display in the response 0 - 1000 (default: 1000)
`marker`	String	Optional	Specify objects from place where the list should start, in the UTF-8 binary order

Request example

The following is a sample request.

GET /{bucket-name} HTTP/1.1
Content-Type: text/plain
Host: kr.object.ncloudstorage.com
X-Amz-Date: {Timestamp}
Authorization: {authorization-string}

Responses

The following describes the response format.

Response headers

For response headers common to all Object Storage APIs, see Object Storage common response headers.

Response status codes

For response status codes common to all Object Storage APIs, see Object Storage response status codes.

Response example

The following is a sample response.

HTTP/1.1 200 OK
Date: Wed, 24 Aug 2016 17:45:25 GMT
Accept-Ranges: bytes
x-amz-request-id: xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
Content-Type: application/xml
Content-Length: 909

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Name>hcdocker</Name>
    <Prefix></Prefix>
    <Marker></Marker>
    <MaxKeys>10</MaxKeys>
    <Delimiter>/</Delimiter>
    <IsTruncated>false</IsTruncated>
    <CommonPrefixes><Prefix>ncpdocker/</Prefix></CommonPrefixes>
    <Contents>
        <Key>ncpdocker.txt</Key>
        <LastModified>2024-04-02T00:57:49.695Z</LastModified>
        <ETag>&quot;xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&quot;</ETag>
        <Size>12</Size>
        <Owner>
            <ID>ncp-xxxxxxx-0</ID>
            <DisplayName>ncp-xxxxxxx-0</DisplayName>
        </Owner>
        <StorageClass>Standard</StorageClass>
    </Contents>
</ListBucketResult>