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

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

GET Bucket (List Objects) Version 2

処理概要

バケット内のオブジェクトリスト(objectは1000エントリまで)を返します。continuation-tokenを使って1001エントリ以降を取得できます。
指定bucketのオブジェクトリストの一部を返すリクエストパラメータを使用できます。200 OKのレスポンスのなかには、有効または無効なXMLが含まれています。
本APIを利用する場合、署名バージョン4を利用する必要があります。

リクエスト

リクエストパラメータ

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

Name Type Description Required
delimiter string デリミタはグループキーに指定した文字です。 no
max-keys string レスポンスボディで返されるキーの最大値を設定します。レスポンスに含まれるキーは、この値より少なくなり、多くなることはありません。検索基準によって追加のキーが得られそうであっても、max-keysの値を超える数を返しませんが、<isTruncated>true</isTruncated>とされます。 no
prefix string 指定した接頭辞から始まるキーのみを選択します。接頭辞を使うことで、別のグループ化キーと区別することができます(ファイルシステムでのフォルダのように、接頭辞を使ってキーをグループ化することもできます)。 no
continuation-token string オブジェクトの数がデフォルト上限値の1000以上またはmax-keysで指定した値以上ある場合に、NextContinuationTokenで返された値を指定して残りのエントリを取得します。 no
fetch-owner string Owner情報を取得する際に指定します。 no
start-after string 指定したオブジェクトキー名の後のリストを取得する際に指定します。 no

リクエストヘッダー

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

リクエストボディ

なし

リクエストサンプル

GET /sample-bucket?list-type=2 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 オブジェクトのメタデータを格納するコンテナ
NextContinuationToken string

レスポンスに含まれるオブジェクトの数がデフォルト値1000以上またはmax-keysで指定した値以上ある場合、残りのオブジェクトを表示する際にcontinuation-tokenで指定します。

Delimiter string 区切り文字列
KeyCount string レスポンスに含まれるオブジェクトの数
Encoding-Type string エンコードタイプ
XMLレスポンスのなかにオブジェクトキーネームをエンコードします。
ID string オブジェクトのオーナーID
IsTruncated boolean リストが途中で切断されているかを知るフラグ。MaxKeys要素に書かれた最大値を超えていたら、リストは切断されます。
Key string オブジェクトのキー
LastModified dateTime 最終更新日時
StartAfter 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/">
    <Name>string</Name>
    <Prefix>string</Prefix>
    <StartAfter>string</StartAfter>
    <KeyCount>string</KeyCount>
    <MaxKeys>string</MaxKeys>
    <Delimiter>string</Delimiter>
    <IsTruncated>Boolean</IsTruncated>
    <Contents>
        <Key>string/Key>
        <LastModified>Date</LastModified>
        <ETag>string</ETag>
        <Size>string</Size>
        <Owner>
            <ID>string</ID>
            <DisplayName>string</DisplayName>
        </Owner>
        <StorageClass>string</StorageClass>
    </Contents>
</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.14.3.94
X-Clv-S3-Version: 2.5
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>
    <StartAfter></StartAfter>
    <KeyCount>5</KeyCount>
    <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>
2022/07/06 2022/07/06