List Servers

サーバを一覧表示します。

APIエンドポイント

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

HTTPメソッドとURI

GET

/v2.1/{project_id}/servers

HTTPステータスコード

正常時：200

エラー時：400,401,403

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

名前	In	Type	デフォルト値 /必須指定	Description
project_id	path	string	必須	プロジェクトのUUID
access_ip_v4	query	string	任意	サーバアクセス用のIPv4アドレスでレスポンスを絞り込みます。
changes-since	query	string	任意	サーバの最新更新日時でレスポンスを絞り込みます。最近削除されるサーバも返却される場合があります。日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。例：2015-08-27T09:49:58-05:00
deleted	query	boolean	任意	削除済みのリソースも表示します。ただし、これらの削除済みリソースは通知なしで削除される場合がありますので、注意が必要です。
flavor	query	string	任意	サーバのフレーバーUUIDでレスポンスを絞り込みます。フレーバーはメモリ、ディスクサイズとCPUの組み合わせです。
image	query	string	任意	サーバのイメージのUUIDでレスポンスを絞り込みます。
ip	query	string	任意	絞り込むためのIPv4アドレス
ip6	query	string	任意	絞り込むためのIPv6アドレス注: マイクロバージョン2.5以上を指定してください。
kernel_id	query	string	任意	AMIを利用する場合に、サーバのカーネルイメージのUUDIでレスポンスを絞り込みます。
limit	query	integer	任意	クエリ結果で返却される項目の最大数指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、サーバリストの続きを取得することができます。
marker	query	string	任意	前回のレスポンスの最後の項目のID limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、サーバリストの続きを取得することができます。
name	query	string	任意	サーバの名前でレスポンスを絞り込みます。正規表現で絞り込むことも可能です。
not-tags	query	string	任意	サーバのタグでレスポンスを絞り込みます。指定するタグすべてを持たないサーバだけが返却されます(NOT (tag1 and tag2))。タグはコンマで区切ります。注: マイクロバージョン2.26以上を指定してください。
not-tags-any	query	string	任意	サーバのタグでレスポンスを絞り込みます。指定するタグのどれにも一致しないサーバが返却されます(NOT (tag1 or tag2))。タグはコンマで区切ります。注: マイクロバージョン2.26以上を指定してください。
ramdisk_id	query	string	任意	AMIを利用する場合に、ramディスクのUUIDでレスポンスを絞り込みます。
reservation_id	query	string	任意	複数のサーバを作成するための呼び出しで返却する予約ID
sort_dir	query	string	desc 任意	ソートの方向 asc (ascending：昇順)、またはdesc (descending：降順)です。複数のソートキーとソート方向を指定することができます。ソート方向を省略する場合は、sort_keyの属性のデフォルト方向が使われます。
sort_key	query	string	created_at 任意	サーバの属性でレスポンスをソートします。省略する場合は、sort_keyの属性のデフォルト方向が使われます。以下の値が有効です。 access_ip_v4 access_ip_v6 auto_disk_config availability_zone config_drive created_at display_description display_name host hostname image_ref instance_type_id kernel_id key_name launch_index launched_at locked_by node power_state progress project_id ramdisk_id root_device_name task_state terminated_at updated_at user_id uuid vm_state
status	query	string	任意	ACTIVEなどのサーバ状況でレスポンスを絞り込みます。注: マイクロバージョン2.37以前：無効なstatusを指定すると空リストを返します。マイクロバージョン2.38以降：無効なstatusを指定すると400エラーを返します。
tags	query	string	任意	サーバのタグでレスポンスを絞り込みます。すべてのタグに一致するサーバだけが返却されます(tag1 and tag2)。タグはコンマで区切ります。注: マイクロバージョン2.26以上を指定してください。
tags-any	query	string	任意	サーバのタグでレスポンスを絞り込みます。指定するタグのどれかに一致するサーバが返却されます(tag1 or tag2)。タグはコンマで区切ります。注: マイクロバージョン2.26以上を指定してください。

レスポンスボディ（正常系）の説明

名前	Type	Description
servers	array	サーバのオブジェクト
id	string	サーバのUUID
links	array	サーバへのリンクURL
name	string	サーバ名

レスポンス例

{
    "servers": [
        {
            "id": "22c91117-08de-4894-9aa9-6ef382400985",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/servers/22c91117-08de-4894-9aa9-6ef382400985",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/6f70656e737461636b20342065766572/servers/22c91117-08de-4894-9aa9-6ef382400985",
                    "rel": "bookmark"
                }
            ],
            "name": "new-server-test"
        }
    ]
}