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

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

listNodes

機能の処理概要

仮想サーバー一覧の取得

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

リクエストパラメーター

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

レスポンスオブジェクト

以下の形式で応答します。

フィールド 説明
autoscaleout オートスケールタイプのロードバランサー配下に属する仮想サーバーの詳細情報を返します
cluster クラスタータイプのロードバランサー配下に属する仮想サーバーの詳細情報を返します
vm 契約アカウントに属する全ての仮想サーバーのうち、オートスケールタイプならびにクラスタータイプそれぞれのロードバランサー配下に属さない仮想サーバーの詳細情報を返します
allow_resize_without_reboot 仮想サーバーを再起動せずに各リソースサイズの変更ができるか否かを返します

true : 再起動せずにサイズ変更可能
false : 上記以外の状態
allowed_hot_migrate 仮想サーバーがホットマイグレーションをすることができるか否かを返します(仮想サーバー構築時のOSテンプレートに依存します)

true : ホットマイグレーションが可能
false : 上記以外の状態
allowed_swap 仮想サーバーでスワップディスクの使用ができるか否かを返します(仮想サーバー構築時のOSテンプレートに依存します)

true : スワップディスクの使用が可能
false : 上記以外の状態
booted 仮想サーバーの稼働状態を返します

true : 仮想サーバーが稼働中の状態
false : 上記以外の状態
built 仮想サーバーの構築状態を返します

true : 構築済みの状態
false : 上記以外の状態
cpu_shares 仮想サーバーに割り当てられているCPU占有率を返します
cpus 仮想サーバーに割り当てられている仮想CPUコア数を返します
created_at 仮想サーバーの作成日時を返します
日時は下記のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ
enable_autoscale 仮想サーバーにおけるオートスケールの設定状態を返します

true : オートスケールの設定がされてる状態
false : 上記以外の状態
enable_monitis 仮想サーバーにおいて、オートスケールのステータスを監視するデーモンの稼動状態を返します

true : 有効な状態
false : 上記以外の状態
hostname 仮想サーバーに設定されているホスト名を返します
hypervisor_id 仮想サーバーが使用するハイパーバイザーのIDを返します
id 仮想サーバーのIDを返します
identifier 仮想サーバーの識別子を返します
initial_root_password 仮想サーバーの初期のrootパスワードを返します
ip 指定した仮想サーバーに割り当てられているIPアドレスを返します
ip_addresses 仮想サーバーに割り当てられているIPアドレスとその詳細情報を返します
このフィールドに含まれるパラメーターの詳細は、10.1. listIpAddresses の項をご参照ください
label 仮想サーバーに設定したラベルを返します
locked 仮想サーバーのロック状態を返します

true : 仮想サーバーがロックされている状態
false : 上記以外の状態
memory 仮想サーバーに割り当てられているメモリ容量を返します

単位はMB(MegaBytes)です
min_disk_size 指定されたテンプレートから仮想サーバーを構築するために必要な最少のディスクサイズを返します
note ユーザーアカウントに紐付いて登録した注意情報を返します
operating_system 仮想サーバーが使用しているOSの種類を返します
operating_system_distro 仮想サーバーの構築時に使用したOSのディストリビューションの種類を返します
recovery_mode 仮想サーバーがリカバリーモードで起動している状態か否かを返します

true : 仮想サーバーがリカバリーモードで起動中の状態
false : 上記以外の状態
state 仮想サーバーの状態を返します

on : 起動中
off : 停止中
running : タスク実行中
pending : タスク実行待ち
suspended 仮想サーバーが停止中の状態か否かを返します

true : 仮想サーバーが停止中の状態
false : 上記以外の状態
template_id 仮想サーバー構築時に指定したテンプレートのIDを返します
template_label 仮想サーバー構築時に指定したテンプレートのラベル(名称)を返します
total_disk_size 仮想サーバーに割り当てられている全てのディスクのディスク容量を返します
単位はGB(Giga Bites) です
type 指定した仮想サーバーの種類を返します

vm : 仮想サーバー
updated_at 仮想サーバーの設定が最後にアップデートされた日時を返します
日時は下記のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ

リクエストサンプル

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

レスポンスサンプル

{
  "vm": {
    "ID_of_VM": {
      "cpus": 1,
      "label": "VM-Label-example",
      "created_at": "2012-08-10T12:37:40+09:00",
      "operating_system_distro": "rhel",
      "cpu_shares": 1,
      "enable_autoscale": false,
      "operating_system": "linux",
      "template_id": ID_of_Template,
      "allowed_swap": true,
      "memory": 128,
      "updated_at": "2012-08-22T14:17:02+09:00",
      "allow_resize_without_reboot": true,
      "recovery_mode": null,
      "enable_monitis": false,
      "hypervisor_id": ID_of_Hypervisor,
      "id": ID_of_VM,
      "allowed_hot_migrate": true,
      "note": null,
      "suspended": false,
      "booted": false,
      "hostname": "gmocloud1.example.com",
      "template_label": "Template-Label-example",
      "total_disk_size": 6,
      "identifier": "Identifier_of_VM",
      "initial_root_password": "Password",
      "min_disk_size": 5,
      "built": true,
      "locked": true,
      "state": "locked",
      "ip_addresses": {
        "ID_of_IpAddress": {
          "address": "192.168.0.100",
          "disallowed_primary": false,
          "netmask": "255.255.255.0",
          "created_at": "2012-08-10T09:12:23+09:00",
          "broadcast": "192.168.0.255",
          "updated_at": "2012-08-10T09:12:23+09:00",
          "network_id": ID_of_Network,
          "network_address": "192.168.0.0",
          "free": false,
          "id": ID_of_IpAddress,
          "gateway": "192.168.0.254"
        }
      },
      "ip": [
        "192.168.0.100"
      ],
      "type": "vm"
    }
  },
  "cluster": {
    "ID_of_VM": {
      "cpus": 1,
      "label": "Template-Label-example",
      "created_at": "2012-08-22T12:26:52+09:00",
      "operating_system_distro": "rhel",
      "cpu_shares": 1,
      "enable_autoscale": false,
      "operating_system": "linux",
      "template_id": ID_of_Template,
      "allowed_swap": true,
      "memory": 128,
      "updated_at": "2012-08-22T14:17:02+09:00",
      "allow_resize_without_reboot": true,
      "recovery_mode": null,
      "enable_monitis": false,
      "hypervisor_id": ID_of_Hypervisor,
      "id": ID_of_VM,
      "allowed_hot_migrate": true,
      "note": null,
      "suspended": false,
      "booted": true,
      "hostname": "gmocloud2.example.jp",
      "template_label": "Template-Label-examplen",
      "total_disk_size": 6,
      "identifier": "Identifier_of_VM",
      "initial_root_password": "Password",
      "min_disk_size": 5,
      "built": true,
      "locked": false,
      "state": "on",
      "ip_addresses": {
        "ID_of_IpAddress": {
          "address": "192.168.0.101",
          "disallowed_primary": false,
          "netmask": "255.255.255.0",
          "created_at": "2012-08-17T17:29:17+09:00",
          "broadcast": "192.168.0.255",
          "updated_at": "2012-08-17T17:29:17+09:00",
          "network_id": ID_of_Network,
          "network_address": "192.168.0.0",
          "free": false,
          "id": ID_of_IpAddress,
          "gateway": "192.168.0.254"
        }
      },
      "ip": [
        "192.168.0.101"
      ],
      "type": "vm"
    },
    "ID_of_VM": {
      "cpus": 1,
      "label": "VM-Label-example",
      "created_at": "2012-08-22T12:28:13+09:00",
      "operating_system_distro": "rhel",
      "cpu_shares": 1,
      "enable_autoscale": false,
      "operating_system": "linux",
      "template_id": ID_of_Template,
      "allowed_swap": true,
      "memory": 128,
      "updated_at": "2012-08-22T14:17:02+09:00",
      "allow_resize_without_reboot": true,
      "recovery_mode": null,
      "enable_monitis": false,
      "hypervisor_id": ID_of_Hypervisor,
      "id": ID_of_VM,
      "allowed_hot_migrate": true,
      "note": null,
      "suspended": false,
      "booted": true,
      "hostname": "gmocloud3.example.com",
      "template_label": "Template-Label-example",
      "total_disk_size": 6,
      "identifier": "Identifier_of_VM",
      "initial_root_password": "Password",
      "min_disk_size": 5,
      "built": true,
      "locked": false,
      "state": "on",
      "ip_addresses": {
        "ID_of_IpAddress": {
          "address": "192.168.0.102",
          "disallowed_primary": false,
          "netmask": "255.255.255.0",
          "created_at": "2012-08-17T17:30:35+09:00",
          "broadcast": "192.168.0.255",
          "updated_at": "2012-08-17T17:30:35+09:00",
          "network_id": ID_of_Network,
          "network_address": "192.168.0.0",
          "free": false,
          "id": ID_of_IpAddress,
          "gateway": "192.168.0.254"
        }
      },
      "ip": [
        "192.168.0.102"
      ],
      "type": "vm"
    }
  },
  "autoscaleout": {
    "ID_of_VM": {
      "cpus": 1,
      "label": "VM-Label-example",
      "created_at": "2012-08-22T12:48:27+09:00",
      "operating_system_distro": "rhel",
      "cpu_shares": 5,
      "enable_autoscale": null,
      "operating_system": "linux",
      "template_id": ID_of_Template,
      "allowed_swap": true,
      "memory": 128,
      "updated_at": "2012-08-22T14:17:02+09:00",
      "allow_resize_without_reboot": true,
      "recovery_mode": null,
      "enable_monitis": true,
      "hypervisor_id": ID_of_Hypervisor,
      "id": ID_of_VM,
      "allowed_hot_migrate": true,
      "note": null,
      "suspended": false,
      "booted": true,
      "hostname": "gmocloud4.example.com",
      "template_label": "Template-Label-example",
      "total_disk_size": 6,
      "identifier": "Identifier_of_VM",
      "initial_root_password": "Password",
      "min_disk_size": 5,
      "built": true,
      "locked": false,
      "state": "on",
      "ip_addresses": {
        "ID_of_IpAddress": {
          "address": "192.168.0.103",
          "disallowed_primary": false,
          "netmask": "255.255.255.0",
          "created_at": "2012-08-17T17:30:35+09:00",
          "broadcast": "192.168.0.255",
          "updated_at": "2012-08-17T17:30:35+09:00",
          "network_id": ID_of_Network,
          "network_address": "192.168.0.0",
          "free": false,
          "id": ID_of_IpAddress,
          "gateway": "192.168.0.254"
        }
      },
      "ip": [
        "192.168.0.103"
      ],
      "type": "vm"
    }
  }
}

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

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

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

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

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

お問い合わせ