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

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

getNode

機能の処理概要

仮想サーバーの詳細情報の取得

指定した仮想サーバーの詳細情報を返します。
指定した仮想サーバーIDが無効であるか、存在しない場合はエラーを返します。

リクエストパラメーター

この機能の実行時には以下のパラメーターを指定してください。

パラメーター 説明 必須
Identifier VM識別子

(後述の virtual_machine_id と同意で、一定の期間経過後にこのパラメーターは廃止します)

仮想サーバーの識別子を指定します
この Identifier か virtual_machine_id のいずれかが必須です
仮想サーバーの識別子は4.1. listNodes APIで取得できます
4.1. listNodes APIのレスポンスオブジェクトのうち、identifier が該当します
( ○ )
virtual_machine_id 仮想サーバーID

仮想サーバーのIDを指定します
この virtual_machine_id か Identifier のいずれかが必須です
仮想サーバーIDは4.1. listNodes APIで取得できます
4.1. listNodes APIのレスポンスオブジェクトのうち、id が該当します
( ○ )

レスポンスオブジェクト

4.1. listNode と同じ形式で応答します。
詳細は 4.1. listNode のレスポンスオブジェクトをご参照ください。
なお、4.1. listNodeのレスポンスに含まれないオブジェクトについては以下の通りです。

フィールド 説明
backup 指定した仮想サーバーのバックアップのサイズ(容量)を返します
backups 指定した仮想サーバーのバックアップの状況とバックアップサイズを返します
(このフィールドに含まれるパラメーターの詳細は 6.1. listBackups の項をご参照ください)
backup_size 指定した仮想サーバーのバックアップのサイズ(容量)の合計値を返します
disks 指定した仮想サーバーに割り当てられているディスクとその詳細情報を返します
(このフィールドに含まれるパラメーターの詳細は5.1. listDisks の項をご参照ください)
ip 指定した仮想サーバーに割り当てられているIPアドレスを返します
network_interfaces 指定した仮想サーバーで設定されているネットワークインターフェースの詳細情報を返します
このフィールドに含まれるパラメーターの詳細は 7.1. listNetworkInterfaces の項をご参照ください
type 指定した仮想サーバーの種類を返します

VM : 仮想サーバー
LB : ロードバランサー

リクエストサンプル

https://api.gmocloud.com/Cloud-Zone-ID/?Action=getNode&AccessKeyId= AccessKeyId &Version=1.0&Identifier=Id_of_VM&Signature=Signature

レスポンスサンプル

{
  "cpus": 1,
  "label": "VM-Label-example",
  "created_at": "2012-07-19T12:32:33+09:00",
  "operating_system_distro": "rhel",
  "cpu_shares": 1,
  "enable_autoscale": false,
  "operating_system": "linux",
  "template_id": 9,
  "allowed_swap": true,
  "memory": 128,
  "updated_at": "2012-07-20T23:42:51+09:00",
  "allow_resize_without_reboot": true,
  "recovery_mode": false,
  "enable_monitis": false,
  "hypervisor_id": Id_of_HV,
  "id": Id_of_VM,
  "allowed_hot_migrate": true,
  "note": null,
  "suspended": false,
  "booted": true,
  "hostname": "gmocloud.example.jp",
  "template_label": "CentOS 6.0 LAMP x64 xen",
  "total_disk_size": 6,
  "identifier": "Identifier_of_VM",
  "initial_root_password": "Password",
  "min_disk_size": 5,
  "built": true,
  "locked": false,
  "state": "on",
  "ip_addresses": [
    {
      "ip_address": {
        "address": "192.168.0.100",
        "disallowed_primary": false,
        "netmask": "255.255.255.0",
        "created_at": "2012-06-13T19:59:42+09:00",
        "broadcast": "192.168.0.255",
        "updated_at": "2012-06-13T19:59:42+09:00",
        "network_id": Id_of_Network,
        "network_address": "192.168.0.0",
        "free": false,
        "id": Id_of_IPaddress,
        "gateway": "192.168.0.254"
      }
    }
  ],
  "type": "vm",
  "ip": [
    "192.168.0.100"
  ],
  "disks": {
    "Id_of_disk": {
      "created_at": "2012-07-19T12:32:33+09:00",
      "add_to_linux_fstab": null,
      "disk_size": 5,
      "updated_at": "2012-07-19T12:32:46+09:00",
      "primary": true,
      "data_store_id": Id_of_DataStore,
      "id": Id_of_disk,
      "disk_vm_number": 1,
      "is_swap": false,
      "mount_point": null,
      "identifier": "Identifier_of_Disk",
      "virtual_machine_id": Id_of_VM,
      "has_autobackups": true,
      "built": true,
      "locked": false
    },
    }
  "backup": [
    "210520",
    "210540"
  ],
  "backup_size": 421060,
  "network_interfaces": {
    "Id_of_NetworkInterface": {
      "label": "eth0",
      "created_at": "2012-07-19T12:32:33+09:00",
      "usage": null,
      "updated_at": "2012-07-20T23:50:59+09:00",
      "primary": true,
      "id":Id_of_VM,
      "usage_month_rolled_at": null,
      "mac_address": "00:00:00:00:00:00",
      "default_firewall_rule": "ACCEPT",
      "usage_last_reset_at": null,
      "rate_limit": 1,
      "identifier": "Identifier_of_NetworkInterface ",
      "network_join_id": Id_of_Network_join_id,
      "virtual_machine_id": Id_of_VM
    }
  }
}

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

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

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

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

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

お問い合わせ