GMOクラウド Public APIリファレンス

サポートトップ » GMOクラウド Public トップ » APIリファレンス

listHypervisors

機能の処理概要

ハイパーバイザー一覧の取得

指定したクラウドゾーンに属する全てのハイパーバイザーの詳細情報の一覧を取得します。

リクエストパラメーター

この機能の実行時に指定するパラメーターはありません。

レスポンスオブジェクト

XenとKVM、それぞれのハイパーバイザー種類別に以下の形式で応答します。

フィールド 説明
xen ハイパーバイザー形式が Xenの種類の情報が含まれます
kvm ハイパーバイザー形式が KVMの種類の情報が含まれます
cpu_cores 1つのハイパーバイザーに紐付く、物理CPUのコア数を返します
created_at ハイパーバイザーがGMOクラウドPublicのシステムの中で作成された日時を返します
日時は以下のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ
data_stores ハイパーバイザーが使用することができるデータストアIDとそれぞれのデータストアの空きディスク容量を返します
データストアはデータストアグループに属します
フォーマットは以下の形式で、ディスク容量の単位はGB(GigaBytes)です

”DataStore-ID”: Disk-Available-Size
data_store_group ハイパーバイザーが使用することができるデータストアグループIDとそれぞれのデータストアグループの空きディスク容量を返します
データストアグループの空き容量は、属するデータストアの空き容量の合計と一致します
フォーマットは以下の形式で、ディスク容量の単位はGB(GigaBytes)です

”DataStoreGroup-ID”: Disk-Available-Size
disable_failover ハイパーバイザーがフェイルオーバーできるか否かを返します

true : フェイルオーバーできない設定
false : 上記以外の設定
enabled ハイパーバイザーの利用可能状態を返します

true : ハイパーバイザーを利用可能な状態
false : 上記以外の状態
free_memory ハイパーバイザーにおいて、収容する仮想サーバーに割り当てられていない空きメモリ容量を返します
単位はMB(MegaBytes)です
hypervisor_group_id ハイパーバイザーに割り当てられたハイパーバイザー・グループIDを返します
hypervisor_type ハイパーバイザーの種類を返します
id ハイパーバイザーのIDを返します
label ハイパーバイザーのラベルを返します
locked ハイパーバイザーのロック状態を返します

true : ハイパーバイザーがロックされている状態
false : 上記以外の状態
memory_allocated_by_running_vms ハイパーバイザーにおいて、収容している全ての仮想サーバーに割り当て済みのメモリの総容量を返します
単位はMB(MegaBytes)です
memory_overhead ハイパーバイザーにおいて、全ての仮想サーバーに割り当て済みのメモリの総容量から、稼働中の仮想サーバーに割り当て済みのメモリの総容量を除いた残りのメモリ容量を返します
単位はMB(MegaBytes)です
online ハイパーバイザーの利用可能状態を返します

true : 利用可能な状態
false : 上記以外の状態
total_cpus 1つの仮想サーバーに設定可能なCPUコア数の上限を返します
total_memory ハイパーバイザーにおいて使用可能なメモリの総容量を返します
単位はMB(MegaBytes)です
total_memory_allocated_by_vms ハイパーバイザーにおいて全ての仮想サーバーに割り当て済みのメモリの総容量を返します
単位はMB(MegaBytes)です
updated_at ハイパーバイザーの最終アップデート日時を返します
日時は以下のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ
used_cpu_resources ハイパーバイザーにおける仮想CPUコアの使用率をパーセンテージで返します
used_memory ハイパーバイザーにおいて全ての仮想サーバーに割り当て済みのメモリ容量とハイパーバイザーが使用するメモリのオーバーヘッドの合計容量を返します
単位はMB(MegaBytes)です

リクエストサンプル

https://api.gmocloud.com/Cloud-Zone-ID/?Action=listHypervisors&AccessKeyId=AccessKeyID&Version=1.0&Signature=Signature

レスポンスサンプル

{
  "xen": {
    "ID_of_HV": {
      "label": "HV-Label-example",
      "created_at": "2012-06-13T18:59:37+09:00",
      "hypervisor_type": "xen",
      "used_cpu_resources": 2491,
      "memory_allocated_by_running_vms": 31088,
      "updated_at": "2012-08-14T21:07:19+09:00",
      "enabled": true,
      "hypervisor_group_id": ID_of_HV-Group,
      "id": ID_of_HV,
      "total_memory": 147445,
      "total_cpus": 24,
      "memory_overhead": 4096,
      "free_memory": 109189,
      "cpu_cores": 12,
      "locked": false,
      "online": true,
      "total_memory_allocated_by_vms": 34160,
      "data_stores": {
        "5": 39,
        "25": 1470,
        "1": 60,
        "19": 24,
        "13": 80,
        "9": 80,
        "23": 1176
      },
      "data_store_groups": {
        "3": 2929
      },
      "used_memory": 38256
    },
"kvm": {
    "ID_of_HV": {
      "label": "HV-Label-example",
      "created_at": "2012-08-09T12:16:31+09:00",
      "hypervisor_type": "kvm",
      "used_cpu_resources": 1700,
      "memory_allocated_by_running_vms": 35488,
      "updated_at": "2012-08-14T21:07:22+09:00",
      "enabled": true,
      "hypervisor_group_id": ID_of_HV-Group,
      "id": ID_of_HV,
      "total_memory": 144966,
      "total_cpus": 24,
      "memory_overhead": 4096,
      "free_memory": 105254,
      "cpu_cores": 12,
      "locked": false,
      "online": true,
      "total_memory_allocated_by_vms": 35616,
      "data_stores": {
        "15": 301,
        "21": 463,
        "17": 258,
        "7": 481,
        "3": 244,
        "11": 344
      },
      "data_store_groups": {
        "3": 2091
      },
      "used_memory": 39712
    },
    }
  }
}

このガイドで問題は解決しましたか?

ご回答ありがとうございました。

引き続きGMOクラウド サポートサイトをご利用ください。

ご回答ありがとうございました。

GMOクラウド Public サポートまでお問い合わせください。

お問い合わせ