ニフクラAPI (オブジェクトストレージサービス: GetBucketVersion2)

GetBucketVersion2

処理概要

バケット内のオブジェクトの一部または全部(最大1000)を一覧表示します。

リクエストURL

GET /{Bucket}

指定するパラメーター

ヘッダーパラメーター

パラメーター	型	説明	必須
x-amz-content-sha256	string	ペイロード全体の計算されたSHA256チェックサム	○
x-amz-date	string	リクエスト側で生成した現在日時	○
Authorization	string	リクエスト認証に用いる文字列	○

パスパラメーター

パラメーター	型	説明	必須
Bucket	string	バケット名	○

クエリパラメーター

パラメーター	型	説明	必須
delimiter	string	キーをグループ化するために使用する文字
encoding-type	string	レスポンスのエンコード方法を指定します。
marker	string	バケット内のオブジェクトを一覧表示するときに使用するキーを指定します。
prefix	string	応答本文に返されるキーを前方一致でフィルタする文字列
continuation-token	string	IsTruncatedの値がtrueになると、このフィールドのキー名を後続の要求の継続トークンとして使用して、次のオブジェクトのセットを取得できます。
list-type	string	APIのバージョン2ではこのパラメーターが必要であり、値を2に設定する必要があります。	○
max-keys	string	応答本文に返されるキーの最大数を設定します。 最大：1000 Default: 1000
fetch-owner	string	本APIではデフォルトで所有者情報を返しません。 応答に所有者情報が必要な場合は、値をtrueに設定します。 Default: false
start-after	string	指定したオブジェクトキー名の後のリストを取得する場合に指定します。

応答フィールド

レスポンスヘッダー

フィールド (項目)	型	説明
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エンドポイントとしてリクエストを受け付けたことを示す番号

レスポンスボディ

フィールド (項目)	型	説明
ListVersionsResult	structure	レスポンスのコンテナ
␣Name	string	バケット名
␣Prefix	string	この文字列から始まるオブジェクトの一覧を返却します。
␣StartAfter	string	start-afterがリクエストされた場合、レスポンスに含まれるコンテナ
␣ContinuationToken	string	ContinuationTokenがリクエストされた場合、レスポンスに含まれるコンテナ
␣NextContinuationToken	string	IsTruncatedの値がtrueになると、このフィールドのキー名を後続の要求のマーカーとして使用して、次のオブジェクトのセットを取得できます。
␣KeyCount	string	応答に含まれるキーの数
␣MaxKeys	string	レスポンスに含める最大オブジェクト数
␣Delimiter	string	デリミタで使用される文字列
␣Encoding-Type	string	XMLレスポンス内のオブジェクトキー名をエンコードするために使用するエンコードタイプ
␣IsTruncated	boolean	結果のオブジェクトの件数がMaxKeysによって指定された数を超えている場合TRUE、超えない場合はFALSEが返されます。
␣Contents	list	各オブジェクトのメタ情報を含むコンテナ
␣␣Key	string	オブジェクトのキー
␣␣LastModified	timestamp	オブジェクトの最終更新日時
␣␣ETag	string	オブジェクトのハッシュ
␣␣Size	string	オブジェクトのサイズ（byte）
␣␣Owner	string	オブジェクトの所有者情報
␣␣␣ID	string	オブジェクト所有者のID
␣␣␣DisplayName	string	オブジェクトの所有者名
␣␣StorageClass	string	STANDARD | STANDARD_IA | ONEZONE_IA | REDUCED_REDUNDANCY | GLACIER
␣CommonPrefixes	string	デリミタ指定をした場合にレスポンスに含まれるコンテナ

リクエストサンプル

    GET /general-bucket?continuation-token=object_data_1&list-type=2&max-keys=3&start-after=object_data_1 HTTP/1.1
User-Agent: curl/7.29.0
Host: jp-east-1.storage.api.nifcloud.com
Accept: */*
x-amz-content-sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
x-amz-date:20190829T093438Z
Authorization:AWS4-HMAC-SHA256 Credential=XK8Z3830NBL1BT9WD3HD/20190829/jp-east-1/s3/aws4_request,SignedHeaders=host;x-amz-content-sha256;x-amz-date,Signature=69c66ec1fe91d5c4383f901c8cfac0aac89f050eb15fc6f15a74b54d36644280

  

応答サンプル

    HTTP/1.1 200 OK
Date: Thu, 29 Aug 2019 09:34:38 GMT
Content-Type: application/xml
Content-Length: 927
Connection: keep-alive
x-amz-request-id: 1566367640555363
x-amz-id-2: 12174498
x-ntap-sg-trace-id: f791d0aa60e02841
X-Fcx-Endpoint-Request: EXECUTED_api3-rmp2.management.jp-east-1.local-28845-1814713-1_200

<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Name>general-bucket</Name>
  <Prefix/>
  <ContinuationToken>object_data_1</ContinuationToken>
  <KeyCount>3</KeyCount>
  <MaxKeys>3</MaxKeys>
  <IsTruncated>false</IsTruncated>
  <Contents>
    <Key>object_data_2</Key>
    <LastModified>2019-08-27T08:02:33.460Z</LastModified>
    <ETag>"0acd0dd3a9121a41ed274bbfb11365cc"</ETag>
    <Size>252864</Size>
    <StorageClass>STANDARD</StorageClass>
  </Contents>
  <Contents>
    <Key>object_data_3</Key>
    <LastModified>2019-08-29T09:28:41.593Z</LastModified>
    <ETag>"0acd0dd3a9121a41ed274bbfb11365cc"</ETag>
    <Size>252864</Size>
    <StorageClass>STANDARD</StorageClass>
  </Contents>
  <Contents>
    <Key>object_data_4</Key>
    <LastModified>2019-08-29T09:28:55.977Z</LastModified>
    <ETag>"0acd0dd3a9121a41ed274bbfb11365cc"</ETag>
    <Size>252864</Size>
    <StorageClass>STANDARD</StorageClass>
  </Contents>
</ListBucketResult>