List Hosts#
プライベートリソースの物理ホストとその各ホスト上に配備されている仮想サーバを一覧表示します。
📒注:このAPIを実行するためには、以下条件のどちらかを満たしている必要があります。
- ドメインに対するロールがユーザに設定されている
- ドメインに対するロールが設定されたグループにユーザが属している
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://telemetry.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://telemetry.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v1.0/hosts
HTTPステータスコード#
正常時:200
エラー時:400, 401, 429, 500, 503
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
X-Auth-Token | header | string | 必須 | Domain-Scoped認証トークン |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
hosts | array | 物理ホストごとの稼働状態、および仮想サーバ情報のリストオブジェクト |
name | string | 物理ホスト名 |
state | string | 現在の物理ホストの稼働状態(up/down) |
servers | array | 配備されている仮想サーバ情報(各timestamp時点)のリストオブジェクト |
timestamp | string | 定期的な監視によって仮想サーバ情報を収集した日時 |
id | string | 仮想サーバのUUID |
name | string | 仮想サーバ名 |
project_id | string | プロジェクトのUUID |
project_name | string | プロジェクト名 |
flavor_id | string | フレーバーのUUID |
flavor_name | string | フレーバー名 |
リクエスト例#
curl -H "X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x..." \ "https://telemetry.jp-west-3.cloud.global.fujitsu.com/v1.0/hosts"
レスポンス例#
{ "hosts": [ { "name": "host001", "state": "up", "servers": [ { "timestamp": "2021-01-05T23:45:56", "id": "c8ecccae-aa30-4b5c-a78b-0a7c6169351b", "name": "server001", "project_id": "be9d-6bb56f4f-42e6-b63e-c8ecccae", "project_name": "prj001", "flavor_id": "6bb56f4f-be9d-42e6-b63e-49476629e07c", "flavor_name": "P3-1" } ] } ] }