List container objects, statistics, and metadata#

コンテナの詳細とオブジェクトを一覧表示します。

クエリパラメータには、取得するオブジェクト名のフィルタを指定することができます。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://objectstorage.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://objectstorage.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v2/{account}/{container}

HTTPステータスコード#

正常時:200,204

エラー時:400,401,403,404,405,409,411,412,416,422,500,501

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
X-Auth-Token header string 必須 認証トークン
account path string 必須 プロジェクト単位でユニークに割り当てられる名前
container path string 必須 コンテナ名
limit query integer 任意 一度に取得できるオブジェクトの最大数
取得したオブジェクトの数が、limitパラメータで指定した値より少ない場合、リストは最後まで取得されています。取得したオブジェクトの数が、limitパラメータで指定した値と等しい場合、リストには未取得のオブジェクトが残っています。
1~1000まで指定できます。
marker query string 任意 指定した文字列より後のオブジェクト名一覧を返却します。
end_marker query string 任意 指定した文字列より前のオブジェクト名一覧を返却します。
prefix query string 任意 この文字列から始まるオブジェクトの一覧を返却します。
format query string 任意 レスポンスのフォーマット
json,xml,plainから選択できます。デフォルトは「plain」です。
format=xmlまたはformat=jsonをクエリパラメータに追加すると、オブジェクト名だけでなく、オブジェクトの詳細情報を含む結果を取得します。
format=plainをクエリパラメータに指定すると、改行区切りでオブジェクト名の一覧を取得します。
delimiter query string 任意 オブジェクト名をネスト表示するためのデリミタ
path query string 任意 文字列を指定すると、擬似的なパスでネストされたオブジェクト名で一覧を返却します。delimiterに「/」を指定かつprefixに「{path}/」を指定した場合と同等です。

レスポンスヘッダーの説明#

名前 Type Description
Content-Length string レスポンスボディのバイト数
Connection string 持続接続の状態を表示します。
X-Container-Object-Count integer コンテナ内オブジェクトの総数
Accept-Ranges string ボディに含まれるオブジェクトに対してRangeヘッダーを指定した取得が可能であることを示します。
X-Timestamp integer リクエストを処理した時刻(UNIX Epoch秒表示)
x-ntap-sg-trace-id string このリクエストに対する処理ID
トラブルについて問い合わせる際に利用されます。
X-Container-Bytes-Used integer コンテナ内オブジェクトの合計バイトサイズ
Content-Type string オブジェクトのMIME typeの種類
X-Trans-Id string このリクエストに付与されるID
トラブルについて問い合わせる際に利用されます。
Date string トランザクションが実行された日時
X-Fcx-Endpoint-Request string APIエンドポイントとしてリクエストを受け付けたことを示す番号

レスポンスボディ(正常系)の説明#

名前 Type Description
hash string オブジェクトのMD5チェックサム
last_modified string オブジェクトの作成日と時間またはメタデータが変更された日と時間
bytes integer オブジェクトのサイズ
name string オブジェクト名
content_type string オブジェクトのMIMEタイプ

リクエスト例#

curl -i $publicURL/marktwain?format=json -X GET -H "X-Auth-Token:$token"

レスポンス例#

HTTP/1.1 200 OK
Content-Length: 341
X-Container-Object-Count: 2
Accept-Ranges: bytes
X-Container-Meta-Book: TomSawyer
X-Timestamp: 1389727543.65372
x-ntap-sg-trace-id: 542385569c2fe8a0
X-Container-Bytes-Used: 26
Content-Type: application/json; charset=utf-8
X-Trans-Id: tx26377fe5fab74869825d1-0052d6bdff
Date: Wed, 15 Jan 2014 16:57:35 GMT

[
    {
        "hash": "451e372e48e0f6b1114fa0724aa79fa1",
        "last_modified": "2014-01-15T16:41:49.390270",
        "bytes": 14,
        "name": "goodbye",
        "content_type": "application/octet-stream"
    },
    {
        "hash": "ed076287532e86365e841e92bfc50d8c",
        "last_modified": "2014-01-15T16:37:43.427570",
        "bytes": 12,
        "name": "helloworld",
        "content_type": "application/octet-stream"
    }
]