KDDIクラウドプラットフォームサービス ナレッジサイト

  • HOME
  • 開発者ガイドブック(APIリファレンス)
  • オブジェクトストレージ
  • サービス操作
  • バケット操作
  • GET Bucket (List Object)

GET Bucket (List Object)

処理概要

バケット内のオブジェクトリスト(objectは1000エントリまで)を返します。markerを使って1001エントリ以降を取得できます。

指定bucketのオブジェクトリストの一部を返すリクエストパラメータを使用できます。200 OKのレスポンスのなかには、有効または無効なXMLが含まれています。

リクエスト

リクエストパラメータ

このGETの操作はバケットのオブジェクトリストの一部を返す次の表のリクエストパラメータを使用します。

Name Type Description Required
delimiter string デリミタはグループキーに指定した文字です。 no
encoding-type string レスポンスをエンコードするために要求し、使用するエンコード方式を指定します。 no
marker string 取得したいリストの開始キー名を指定します。指定した文字列からアルファベット順でリストを表示します。 no
max-keys string レスポンスボディで返されるキーの最大値を設定します。レスポンスに含まれるキーは、この値より少なくなり、多くなることはありません。検索基準によって追加のキーが得られそうであっても、max-keysの値を超える数を返しませんが、<isTruncated>true</isTruncated>とされます。 no
prefix string 指定した接頭辞から始まるキーのみを選択します。接頭辞を使うことで、別のグループ化キーと区別することができます(ファイルシステムでのフォルダのように、接頭辞を使ってキーをグループ化することもできます)。 no

リクエストヘッダー

このオペレーションはすべての操作に共通するリクエストヘッダのみを使用しています。詳細については、一般的なリクエストヘッダを参照してください。

リクエストボディ

なし

リクエストサンプル

GET /sample-bucket HTTP/1.1
Host: 192.168.0.1
Date: Tue, 01 Sep 2015 10:00:00 +0000
Authorization: AWS EXAMPLEjU2So5By3H5v2:EXAMPLEAjwlAvEi2cPLfQaM588ROWW90so7LwfPr

レスポンス

レスポンスヘッダー

このオペレーションはすべての操作に共通するレスポンスヘッダのみを使用しています。詳細については、一般的なレスポンスヘッダを参照してください。

レスポンスボディ

Name Type Description
Contents container オブジェクトのメタデータを格納するコンテナ
CommonPrefixes container 区切り文字列をリクエストに指定し、 区切り文字列を基準とした前方をCommon Prefixとするが、 そのCommon Prefixを格納するコンテナ
Delimiter string 区切り文字列
DisplayName string オブジェクトのオーナー名
Encoding-Type string エンコードタイプ
XMLレスポンスのなかにオブジェクトキーネームをエンコードします。
ID string オブジェクトのオーナーID
IsTruncated boolean リストが途中で切断されているかを知るフラグ。MaxKeys要素に書かれた最大値を超えていたら、リストは切断されます。
Key string オブジェクトのキー
LastModified dateTime 最終更新日時
Marker string リクエスト時に指定した開始文字列
MaxKeys string レスポンスボディのなかに指定した最大一覧表示数が返されます。
Name string バケット名
Prefix string 指定した前方一致文字列
Size string オブジェクトサイズ
StorageClass string ストレージ分類。”STANDARD”のみ。
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Contents>
        <ETag>string</ETag>
        <Owner>
            <ID>string</ID>
            <DisplayName>string</DisplayName>
        </Owner>
        <Key>string</Key>
        <Size>string</Size>
        <StorageClass>string</StorageClass>
    </Contents>
    <CommonPrefixes>
        <Prefix>string</Prefix>
    </CommonPrefixes>
    <Delimiter>string</Delimiter>
    <Encoding-Type>string</Encoding-Type>
    <IsTruncated>Boolean</IsTruncated>
    <LastModified>Date</LastModified>
    <Marker>string</Marker>
    <MaxKeys>string</MaxKeys>
    <Name>string</Name>
    <NextMarker>string</NextMarker>
    <Prefix>string</Prefix>
</ListBucketResult>

レスポンスサンプル

HTTP/1.1 200 OK
Date: Tue, 01 Sep 2015 10:00:00 GMT
X-Clv-Request-Id: 01234567-89ab-cdef-0123-456789abcdef
Accept-Ranges: bytes
Server Cleversafe/3.5.1.0 is not blacklisted
Server: Cleversafe/3.5.1.0
X-Clv-S3-Version: 2.4
x-amz-request-id: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/xml
Content-Length: 574
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Name>sample-bucket</Name>
    <Prefix></Prefix>
    <Marker></Marker>
    <MaxKeys>1000</MaxKeys>
    <Delimiter></Delimiter>
    <IsTruncated>false</IsTruncated>
    <Contents>
        <Key>sample-object.txt</Key>
        <LastModified>2015-09-01T09:00:00.000Z</LastModified>
        <ETag>"abcdef0123456789abcdef0123456789"</ETag>
        <Size>123</Size>
        <Owner>
            <ID>56789abc-def0-1234-5678-9abcdef01234</ID>
            <DisplayName>abc0001</DisplayName>
        </Owner>
        <StorageClass>STANDARD</StorageClass>
    </Contents>
</ListBucketResult>
2020/10/24 2020/10/24