List Hypervisors

ハイパーバイザーの一覧を取得します。

📒注: マイクロバージョン2.53以上を指定してください。

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}/os-hypervisors

HTTPステータスコード

正常時：200

エラー時：400, 401, 403

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

名前	In	Type	デフォルト値 /必須指定	Description
project_id	path	string	必須	プロジェクトのUUID
hypervisor_hostname_pattern	query	string	必須	ハイパーバイザーのホスト名を指定します。1ホストだけ指定できます。
with_servers	query	boolean	任意	レスポンスにハイパーバイザー上の VMの情報を含みます。 📒注: noだけ指定できます。

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

名前	Type	Description
hypervisors	object	ハイパーバイザーのオブジェクト
status	string	ハイパーバイザーのステータス
state	string	ハイパーバイザーの電源状態
id	string	ハイパーバイザーのuuid
hypervisor_hostname	string	ハイパーバイザーのホスト名

レスポンス例

{
	"hypervisors": [
		{
			"status": "enabled",
			"state": "up",
			"id": "f92f3fc3-5098-4d96-a465-5ddebdd18da3",
			"hypervisor_hostname": "sv-01-01-13-08.management.jp-east-3.local"
		}
	]
}