ListObjects

Prev Next

Classic/VPC環境で利用できます。

Object Storageのオブジェクトリストを照会します。オペレーションに使用されるリクエストボディはありません。

参考

一度に照会されるオブジェクト数は1,000個に制限され、任意の順番で返されます。
ストレージクラスオペレーションが NAVERクラウドプラットフォームの Object Storageに実装されていない場合、レスポンスコードから返された StorageClassの値はデフォルトです。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET {bucket-name}

リクエスト構文 

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

リクエストヘッダ

Object Storage APIで共通して使用されるヘッダの詳細は、Object Storageの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
bucket-name String Required 作成するバケット

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
prefix String Optional Prefixで始まるオブジェクト名にのみレスポンスするように制限
delimiter String Optional オブジェクトを結合するための基準
  • Prefixと Delimiterの間にあるオブジェクトを1つに結合する
encoding-type String Optional エンコードタイプ
  • XMLでサポートしていない Unicode文字がオブジェクト名に使用された場合、パラメータを URLに設定してエンコード問題を解決
max-keys String Optional レスポンスに表示するオブジェクト数
  • 0~1,000 (デフォルト: 1,000)
marker String Optional UTF-8バイナリ順にリストが始まる位置からオブジェクトを指定

リクエスト例

リクエストのサンプルコードは次の通りです。

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

レスポンス

レスポンス形式を説明します。

レスポンスヘッダ

Object Storage APIで共通して使用されるレスポンスヘッダの詳細は、Object Storageの共通レスポンスヘッダをご参照ください。

レスポンスステータスコード

Object Storage APIで共通して使用されるレスポンスステータスコードの詳細は、Object Storageのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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>