List Servers Detailed
サーバの詳細を一覧表示します。
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/detail
HTTPステータスコード
正常時:200
エラー時:400, 401, 403
リクエストパラメータの説明
名前 | In | Type |
デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
project_id | path | string | 必須 | プロジェクトのUUID |
access_ip_v4 | query | string | 任意 | サーバアクセス用のIPv4アドレスでレスポンスを絞り込みます。 |
auto_disk_config | query | string | 任意 | サーバのdisk_config設定でレスポンスを絞り込みます。「AUTO」または「MANUAL」を指定します。 |
availability_zone | query | string | 任意 | サーバのアベイラビリティゾーンでレスポンスを絞り込みます。 |
config_drive | query | boolean | 任意 | サーバのconfig_drive設定でレスポンスを絞り込みます。 |
changes-since | query | string | 任意 |
サーバの最新更新日時でレスポンスを絞り込みます。削除されるサーバも返却される場合があります。 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。例:2015-08-27T09:49:58-05:00 |
created_at | query | string | 任意 |
サーバの作成日時でレスポンスを絞り込みます。 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。例:2015-08-27T09:49:58-05:00 |
deleted | query | boolean | 任意 | 削除済みのリソースも表示します。ただし、これらの削除済みリソースは通知なしで削除される場合がありますので、注意が必要です。 |
description | query | string | 任意 | サーバの説明でレスポンスを絞り込みます。 |
flavor | query | string | 任意 | サーバのフレーバーUUIDでレスポンスを絞り込みます。フレーバーはメモリ、ディスクサイズとCPUの組み合わせです。 |
hostname | query | string | 任意 | サーバのホスト名でレスポンスを絞り込みます。 |
image | query | string | 任意 | サーバのイメージのUUIDでレスポンスを絞り込みます。 |
ip | query | string | 任意 | 絞り込むためのIPv4アドレス |
kernel_id | query | string | 任意 | AMIを利用する場合に、サーバのカーネルイメージのUUIDでレスポンスを絞り込みます。 |
key_name | query | string | 任意 | サーバのキーペア名でレスポンスを絞り込みます。 |
launch_index | query | string | 任意 | サーバの起動順位でレスポンスを絞り込みます。 |
launched_at | query | string | 任意 |
サーバの起動の日時でレスポンスを絞り込みます。日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。例:2015-08-27T09:49:58-05:00 |
limit | query | integer | 任意 |
クエリ結果で返却される項目の最大数 指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、サーバリストの続きを取得することができます。 |
locked_by | query | string | 任意 | サーバをロックしたユーザーでレスポンスを絞り込みます。「admin」、「owner」、「none」のどれかが指定できます。 |
marker | query | string | 任意 |
前回のレスポンスの最後の項目のID limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、サーバリストの続きを取得することができます。 |
name | query | string | 任意 | サーバの名前でレスポンスを絞り込みます。正規表現で絞り込むことも可能です。 |
node | query | string | 任意 | サーバのノードでレスポンスを絞り込みます。管理者だけが指定可能です。 |
not-tags | query | string | 任意 |
サーバのタグでレスポンスを絞り込みます。指定するタグすべてを持たないサーバだけが返却されます(NOT (tag1 and tag2))。タグはコンマで区切ります。
注: マイクロバージョン2.26以上を指定してください。
|
not-tags-any | query | string | 任意 |
サーバのタグでレスポンスを絞り込みます。指定するタグのどれにも一致しないサーバだけが返却されます(NOT (tag1 or tag2))。タグはコンマで区切ります。
注: マイクロバージョン2.26以上を指定してください。
|
power_state | query | string | 任意 | サーバの電源状況でレスポンスを絞り込みます。 |
progress | query | string | 任意 | サーバの進行状況でレスポンスを絞り込みます。 |
ramdisk_id | query | string | 任意 | AMIを利用する場合に、ramディスクのUUIDでレスポンスを絞り込みます。 |
reservation_id | query | string | 任意 | 複数のサーバを作成するための呼び出しで返却する予約ID |
root_device_name | query | string | 任意 | サーバのルートデバイス名でレスポンスを絞り込みます。 |
sort_dir | query | string |
desc 任意 |
ソートの方向 asc (ascending:昇順)、またはdesc (descending:降順)です。複数のソートキーとソート方向を指定することができます。ソート方向を省略する場合は、sort_keyの属性のデフォルト方向が使われます。 |
sort_key | query | string |
created_at 任意 |
サーバの属性でレスポンスをソートします。省略する場合は、sort_keyの属性のデフォルト方向が使われます。以下の値が有効です。
|
status | query | string | 任意 |
ACTIVEなどのサーバ状況でレスポンスを絞り込みます。 |
tags | query | string | 任意 |
サーバのタグでレスポンスを絞り込みます。指定するすべてのタグに一致するサーバが返却されます(tag1 and tag2)。タグはコンマで区切ります。
注: マイクロバージョン2.26以上を指定してください。
|
tags-any | query | string | 任意 |
サーバのタグでレスポンスを絞り込みます。指定するタグのどれかに一致するサーバが返却されます(tag1 or tag2)。タグはコンマで区切ります。
注: マイクロバージョン2.26以上を指定してください。
|
task_state | query | string | 任意 | サーバのタスク状況でレスポンスを絞り込みます。 |
terminated_at | query | string | 任意 |
サーバの停止日時でレスポンスを絞り込みます。日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。例:2015-08-27T09:49:58-05:00 |
user_id | query | string | 任意 | ユーザーIDでレスポンスを絞り込みます。 |
uuid | query | string | 任意 | サーバのUUIDでレスポンスを絞り込みます。 |
vm_state | query | string | 任意 | サーバのVM状況でレスポンスを絞り込みます。 |
レスポンスボディ(正常系)の説明
名前 | Type | Description |
---|---|---|
server | object | サーバのオブジェクト |
addresses | object | サーバのアドレス情報 |
created | string |
リソースの作成日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。上記の例は、オフセットの値が「-05:00」です。 |
flavor | object | サーバの作成元のフレーバー情報 |
flavor.id | string | フレーバーのID
注: マイクロバージョン2.46までは表示されます。
|
flavor.links | array |
フレーバーへのリンク情報
注: マイクロバージョン2.46までは表示されます。
|
flavor.vcpus | integer |
サーバに割り当てられている仮想CPUの数 注: 表示するにはマイクロバージョン2.47以上を指定してください。
|
flavor.ram | integer |
フレーバーのRAMサイズ(MB) 注: 表示するにはマイクロバージョン2.47以上を指定してください。
|
flavor.disk | integer |
ルートディスクのサイズ(GB) 注: 表示するにはマイクロバージョン2.47以上を指定してください。
|
flavor.ephemeral | integer |
揮発性ディスクのサイズ(GB) 注: 表示するにはマイクロバージョン2.47以上を指定してください。
|
flavor.swap | integer |
スワップ専用ディスクのサイズ(MB) 注: 表示するにはマイクロバージョン2.47以上を指定してください。
|
flavor.original_name | string |
フレーバーの表示名 注: 表示するにはマイクロバージョン2.47以上を指定してください。
|
flavor.extra_specs | object |
フレーバーの拡張仕様のキーと値のペア 注: 表示するにはマイクロバージョン2.47以上を指定してください。
|
flavor.extra_specs.key | string |
フレーバーの拡張仕様のキー 注: 表示するにはマイクロバージョン2.47以上を指定してください。
|
flavor.extra_specs.value | string |
フレーバーの拡張仕様の値 注: 表示するにはマイクロバージョン2.47以上を指定してください。
|
hostId | string | ハッシュされているホストID |
id | string | サーバのUUID |
image | object |
サーバのUUIDとリンクURL ボリュームからブートする場合は、「null」になります。 |
key_name | string | 関連付けられているキーペアの名前 |
links | array | サーバへのリンクURL |
metadata | object | メタデータのキーと値のペア |
name | string | サーバ名 |
accessIPv4 | string | サーバにアクセスするためのIPv4アドレス |
accessIPv6 | string | サーバにアクセスするためのIPv6アドレス |
config_drive | boolean | コンフィグドライブの有無 |
OS-DCF:diskConfig | string |
ディスクの設定 「AUTO」または「MANUAL」を指定します。 |
OS-EXT-AZ:availability_zone | string | アベイラビリティゾーン名 |
OS-EXT-SRV-ATTR:host | string |
ホスト名 管理者だけに表示されます。 |
OS-EXT-STS:power_state | integer |
仮想サーバの電源状況 以下のどれかが表示されます。
|
OS-EXT-STS:task_state | string | 仮想サーバのタスク状況 |
OS-EXT-STS:vm_state | string | VMの状況 |
os-extended-volumes:volumes_attached | array | アタッチされているボリュームのリスト |
os-extended-volumes:volumes_attached.id | string | アタッチされているボリュームのID |
os-extended-volumes:volumes_attached.delete_on_termination | boolean |
「true」の場合は、サーバが削除されると、アタッチされているボリュームも削除されます。
注: 表示するにはマイクロバージョン2.3以上を指定してください。
|
OS-SRV-USG:launched_at | string |
サーバの起動日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。 |
OS-SRV-USG:terminated_at | string |
サーバの削除日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。上記の例は、オフセットの値が「-05:00」です。 |
progress | integer | ビルド進捗率 |
security_groups | array | セキュリティグループのオブジェクト |
security_group.name | string | セキュリティグループの名前 |
status | string | サーバのステータス |
tenant_id | string | プロジェクトのUUID |
updated | string |
リソースの最新更新日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。上記の例は、オフセットの値が「-05:00」です。 |
user_id | string | サーバの所有者のユーザーID |
レスポンス例
{
"servers": [
{
"OS-DCF:diskConfig": "AUTO",
"OS-EXT-AZ:availability_zone": "nova",
"OS-EXT-SRV-ATTR:host": "compute",
"OS-EXT-STS:power_state": 1,
"OS-EXT-STS:task_state": null,
"OS-EXT-STS:vm_state": "active",
"OS-SRV-USG:launched_at": "2017-02-14T19:24:43.891568",
"OS-SRV-USG:terminated_at": null,
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"addresses": {
"private": [
{
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"addr": "192.168.0.3",
"version": 4
}
]
},
"config_drive": "",
"created": "2017-02-14T19:24:42Z",
"description": null,
"flavor": {
"id": "ce448e97-6b84-4ccb-bcd6-618cea3248fd",
"links": [
{
"href": "https://compute.jp-east-3.cloud.global.fujitsu.com/6f70656e737461636b20342065766572/flavors/ce448e97-6b84-4ccb-bcd6-618cea3248fd",
"rel": "bookmark"
}
]
},
"hostId": "2091634baaccdc4c5a1d57069c833e402921df696b7f970791b12ec6",
"id": "764e369e-a874-4401-b7ce-43e4760888da",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/6f70656e737461636b20342065766572/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/764e369e-a874-4401-b7ce-43e4760888da",
"rel": "self"
},
{
"href": "http://openstack.example.com/6f70656e737461636b20342065766572/servers/764e369e-a874-4401-b7ce-43e4760888da",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"os-extended-volumes:volumes_attached": [
{
"delete_on_termination": false,
"id": "volume_id1"
},
{
"delete_on_termination": false,
"id": "volume_id2"
}
],
"progress": 0,
"security_groups": [
{
"name": "default"
}
],
"status": "ACTIVE",
"tags": [],
"tenant_id": "6f70656e737461636b20342065766572",
"updated": "2017-02-14T19:24:43Z",
"user_id": "fake"
}
]
}