Get Bucket(List Objects)#
バケット内のオブジェクトの一部または全部(最大1000)を一覧表示します。
📒注: 本APIは旧バージョンAPIです。「Get Bucket(List Objects) version2」をご利用ください。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://objectstorage-s.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://objectstorage-s.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/{bucket}
HTTPステータスコード#
正常時:200
エラー時:400, 403, 404, 405, 409, 411, 412, 416, 422, 500, 501, 503
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
Bucket | path | string | 必須 | バケット名 |
x-amz-content-sha256 | header | string | 必須 | ペイロード全体の計算されたSHA256チェックサム |
x-amz-date | header | string | 必須 | リクエスト側で生成した現在日時 |
Authorization | header | string | 必須 | リクエスト認証に用いる文字列 |
delimiter | query | string | 任意 | キーをグループ化するために使用する文字 |
encoding-type | query | string | 任意 | レスポンスのエンコード方法を指定します。 |
marker | query | string | 任意 | バケット内のオブジェクトを一覧表示するときに使用するキーを指定します。 |
max-keys | query | string | 1000 任意 |
応答本文に返されるキーの最大数を設定します。 最大:1000 |
prefix | query | string | 任意 | 応答本文に返されるキーを前方一致でフィルタする文字列 |
レスポンスヘッダーの説明#
名前 | Type | Description |
---|---|---|
Date | string | トランザクションが実行された日時 |
Content-Type | string | コンテンツのMIMEタイプ |
Content-Length | string | レスポンスボディのバイト数 |
Connection | string | 持続接続の状態を表示します。 |
x-amz-request-id | string | このリクエストに付与されるID トラブルについて問い合わせる際に利用されます。 |
x-amz-id-2 | string | このリクエストに対する処理ID トラブルについて問い合わせる際に利用されます。 |
x-ntap-sg-trace-id | string | このリクエストに対する処理ID トラブルについて問い合わせる際に利用されます。 |
X-Fcx-Endpoint-Request | string | APIエンドポイントとしてリクエストを受け付けたことを示す番号 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
ListBucketResult | container | レスポンスのコンテナ |
Name | string | バケット名 |
Prefix | string | この文字列から始まるオブジェクトの一覧を返却します。 |
Marker | string | バケットリストのどこから始まるかを示します。 |
NextMarker | string | IsTruncatedの値がtrueになると、このフィールドのキー名を後続の要求のマーカーとして使用して、次のオブジェクトのセットを取得できます。 |
MaxKeys | string | レスポンスに含める最大オブジェクト数 |
Encoding-Type | string | XMLレスポンス内のオブジェクトキー名をエンコードするために使用するエンコードタイプ |
Delimiter | string | デリミタで使用される文字列 |
IsTruncated | boolean | 結果のオブジェクトの件数がMaxKeysによって指定された数を超えている場合TRUE、超えない場合はFALSEが返されます。 |
Contents | XML metadata | 各オブジェクトのメタ情報を含むコンテナ |
Key | string | オブジェクトのキー |
LastModified | date | オブジェクトの最終更新日時 |
Etag | string | オブジェクトのハッシュ |
Size | string | オブジェクトのサイズ(byte) |
Owner | container | オブジェクトの所有者情報 |
ID | string | オブジェクト所有者のID |
DisplayName | string | オブジェクトの所有者名 |
StorageClass | string | STANDARD | STANDARD_IA | ONEZONE_IA | REDUCED_REDUNDANCY | GLACIER |
CommonPrefixes | string | デリミタ指定をした場合にレスポンスに含まれるコンテナ |
リクエスト例#
GET /general-bucket HTTP/1.1 User-Agent: curl/7.29.0 Host: objectstorage-s.jp-east-3.cloud.global.fujitsu.com Accept: */* x-amz-content-sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 x-amz-date:20190606T011501Z Authorization:AWS4-HMAC-SHA256 Credential=XK8Z3830NBL1BT9WD3HD/20190606/jp-east-3/s3/aws4_request,SignedHeaders=host;x-amz-content-sha256;x-amz-date,Signature=656ae645d020362de06c3c22869743d417bad67ab163ac26ce94fd5aa5062b81
レスポンス例#
レスポンスヘッダ
HTTP/1.1 200 OK Date: Thu, 06 Jun 2019 01:15:01 GMT Content-Type: application/xml Content-Length: 1443 Connection: keep-alive x-amz-request-id: 368931563 x-amz-id-2: 12174498 x-ntap-sg-trace-id: 6e44a5bcccede846 X-Fcx-Endpoint-Request: EXECUTED_api3-rmp2.management.jp-east-3.local-28845-1814713-1_200
レスポンスボディ
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>general-bucket</Name> <Prefix/> <Marker/> <MaxKeys>1000</MaxKeys> <IsTruncated>false</IsTruncated> <Contents> <Key>Mpart-Object</Key> <LastModified>2019-06-05T01:47:37.485Z</LastModified> <ETag>"85556031f01111efa565be4451b51bfb-3"</ETag> <Size>505728</Size> <Owner> <ID>42242073901014718119</ID> <DisplayName>fj-k5objt-tenant-99</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> <Contents> <Key>object_data</Key> <LastModified>2019-06-04T06:54:24.981Z</LastModified> <ETag>"0acd0dd3a9121a41ed274bbfb11365cc"</ETag> <Size>252864</Size> <Owner> <ID>42242073901014718119</ID> <DisplayName>fj-k5objt-tenant-99</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> <Contents> <Key>object_data_1</Key> <LastModified>2019-06-04T06:54:50.904Z</LastModified> <ETag>"0acd0dd3a9121a41ed274bbfb11365cc"</ETag> <Size>252864</Size> <Owner> <ID>42242073901014718119</ID> <DisplayName>fj-k5objt-tenant-99</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> <Contents> <Key>object_data_2</Key> <LastModified>2019-06-04T06:56:39.958Z</LastModified> <ETag>"0acd0dd3a9121a41ed274bbfb11365cc"</ETag> <Size>252864</Size> <Owner> <ID>42242073901014718119</ID> <DisplayName>fj-k5objt-tenant-99</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> </ListBucketResult>