Show images

イメージを一覧表示します。

APIエンドポイント

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

HTTPメソッドとURI

GET

/v2/images

HTTPステータスコード

正常時:200

エラー時:400, 401, 403

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

名前 In Type

デフォルト値

/必須指定

Description
limit query integer 任意

クエリ結果で返却される項目の最大数

指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。

marker query string 任意

前回のレスポンスの最後の項目のID

limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。

name query string 任意 レスポンスをイメージの名前で絞り込みます。
owner query string 任意 レスポンスを所有者のプロジェクトのIDで絞り込みます。
protected query boolean 任意 レスポンスをprotectedパラメータの値で絞り込みます。
status query integer 任意 レスポンスをイメージのステータスで絞り込みます。
tag query string 任意 レスポンスをタグで絞り込みます。複数のタグを指定する場合は、すべてのタグを一致するイメージだけが返却されます。
visibility query string 任意 レスポンスをイメージの公開状態で絞り込みます。「public」、「private」、「community」、または「shared」を指定します。「shared」を指定する場合は、実行ユーザーのメンバーステータスが「accepted」となっているイメージだけが返却されます(member_statusで違うステータスを指定する場合を除く)。省略する場合は、メンバーステータスがacceptedで、公開状態が「public」、「prviate」、および「shared」のイメージが表示されます。
member_status query string

accepted

任意

レスポンスをメンバーステータスで絞り込みます。「accepted」、「pending」、「rejected」または「all」です。
size_max query string 任意 レスポンスをイメージの最大サイズで絞り込みます。
size_min query string 任意 レスポンスをイメージの最低サイズで絞り込みます。
created_at query string 任意

比較フィルターで、レスポンスをリソースの作成日時で絞り込みます。(「比較演算子」を参照してください。)

日時の入力形式は以下のISO 8601形式です。

CCYY-MM-DDThh:mm:ss±hh:mm

「±hh:mm」の部分は、UTCからのオフセットで表示されるタイムゾーンです。表示されない場合もあります。

例えば、以下の出力例に、UTCのタイムゾーンからの-05:00のオフセットが想定されます。

2015-08-27T09:49:58-05:00

設定されていない場合は、「null」となります。

updated_at query string 任意

比較フィルターで、レスポンスをリソースの更新日時で絞り込みます。(以下の「比較演算子」を参照してください。)

日時の入力形式は以下のISO 8601形式です。

CCYY-MM-DDThh:mm:ss±hh:mm

「±hh:mm」の部分は、UTCからのオフセットで表示されるタイムゾーンです。表示されない場合もあります。

例えば、以下の出力例に、UTCのタイムゾーンからの-05:00のオフセットが想定されます。

2015-08-27T09:49:58-05:00

設定されていない場合は、「null」となります。

sort_dir query string

desc

任意

ソートの方向

asc (ascending:昇順)、またはdesc (descending:降順)です。

sort_key query string

created_at

任意

属性でソートします。有効な指定値は「name」、「id」、または「updated_at」などです。ソート方向は「sort_key」の値となります。ソート方向を省略する場合は、sort_keyの属性のデフォルト方向が使われます。
sort query string 任意

ソートキーと任意のソート方向のリスト

以下の形式で、コンマ(,)で区切られます。デフォルトの方向はdesc (descending:降順)です。

例: GET /v2/images?sort=name:asc,status:desc

参考:比較演算子

created_atまたはupdated_atで以下の比較演算子を適用できる。

Operator Description
gt 指定する日時よりも新しい日時があるリソースが返却されます。
gte 指定する日時以降の日時があるリソースが返却されます。
eq 指定する日時に一致する日時があるリソースが返却されます。
neq 指定する日時に一致しない日時があるリソースが返却されます。
lt 指定する日時よりも遅い日時があるリソースが返却されます。
lte 指定する日時以前の日時があるリソースが返却されます。

例:GET v2/images?created_at=gt:2016-04-18T21:38:54Z

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

名前 Type Description
images array imageオブジェクトのリスト
first string レスポンスの最初のページのURI
next string

次のレスポンスのページへのURI

最終のページには表示されません。

schema string イメージの一覧表示を定義するスキーマのURL

レスポンス例

{
    "images": [
        {
            "status": "active",
            "name": "cirros-0.3.2-x86_64-disk",
            "tags": [],
            "container_format": "bare",
            "created_at": "2014-11-07T17:07:06Z",
            "disk_format": "qcow2",
            "updated_at": "2014-11-07T17:19:09Z",
            "visibility": "public",
            "self": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27",
            "min_disk": 0,
            "protected": false,
            "id": "1bea47ed-f6a9-463b-b423-14b9cca9ad27",
            "file": "/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file",
            "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
            "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
            "size": 13167616,
            "min_ram": 0,
            "schema": "/v2/schemas/image",
            "virtual_size": null
        },
        {
            "status": "active",
            "name": "F17-x86_64-cfntools",
            "tags": [],
            "container_format": "bare",
            "created_at": "2014-10-30T08:23:39Z",
            "disk_format": "qcow2",
            "updated_at": "2014-11-03T16:40:10Z",
            "visibility": "public",
            "self": "/v2/images/781b3762-9469-4cec-b58d-3349e5de4e9c",
            "min_disk": 0,
            "protected": false,
            "id": "781b3762-9469-4cec-b58d-3349e5de4e9c",
            "file": "/v2/images/781b3762-9469-4cec-b58d-3349e5de4e9c/file",
            "checksum": "afab0f79bac770d61d24b4d0560b5f70",
            "owner": "5ef70662f8b34079a6eddb8da9d75fe8",
            "size": 476704768,
            "min_ram": 0,
            "schema": "/v2/schemas/image",
            "virtual_size": null
        }
    ],
    "schema": "/v2/schemas/images",
    "first": "/v2/images"
}