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

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

getBalancer

機能の処理概要

個別のロードバランサーの詳細情報の取得

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

リクエストパラメーター

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

パラメーター 説明 必須
load_balancer_id ロードバランサーID

ロードバランサーの識別子を指定します
ロードバランサーの識別子は13.1. listBalancers APIで取得できます
13.1. listBalancers APIのレスポンスオブジェクトのうち、autoscaleoutフィールドもしくはclusterフィールドの id が該当します
Identifier ロードバランサー識別子

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

ロードバランサーの識別子を指定します
ロードバランサーの識別子は13.1. listBalancers APIで取得できます
13.1. listBalancers APIのレスポンスオブジェクトのうち、autoscaleoutフィールドもしくはclusterフィールドの identifier が該当します
×

レスポンスオブジェクト

以下の形式で応答します。
各エレメントは、listNode API のレスポンスの構造と同様の構造です。

フィールド 説明
lb ロードバランサーの詳細情報を返します

詳細は listBalancer APIのレスポンスオブジェクトをご参照ください。

リクエストサンプル

https://api.gmocloud.com/Cloud-Zone-Id/?Action=getBalancer&AccessKeyId=AccessKeyId&Version=1.0&Identifier=Identifier_of_LoadBalancer&Signature=Signature

レスポンスサンプル

{
  "cpus": 1,
  "label": "LABEL_of_LB",
  "created_at": "2012-08-10T12:43:00+09:00",
  "operating_system_distro": "lbva",
  "cpu_shares": 10,
  "enable_autoscale": null,
  "operating_system": "linux",
  "template_id": ID_of_Template,
  "allowed_swap": true,
  "memory": 512,
  "updated_at": "2012-08-10T13:02:34+09:00",
  "allow_resize_without_reboot": false,
  "recovery_mode": null,
  "enable_monitis": false,
  "hypervisor_id": ID_of_Hypervisor,
  "id": ID_of_Loadbalancer,
  "allowed_hot_migrate": true,
  "note": null,
  "suspended": false,
  "booted": true,
  "hostname": "loadbalancer.example.com",
  "template_label": "Load Balancer Virtual Appliance",
  "total_disk_size": 6,
  "add_to_marketplace": null,
  "identifier": "Identifier_of_LB",
  "initial_root_password": "Password_of_LB",
  "min_disk_size": 5,
  "built": true,
  "locked": false,
  "state": "on",
  "ip_addresses": {
    "ID_of_IPaddress": {
      "address": "192.168.0.220",
      "disallowed_primary": false,
      "netmask": "255.255.255.0",
      "created_at": "2012-08-10T09:12:24+09:00",
      "broadcast": "192.168.0.255",
      "updated_at": "2012-08-10T09:12:24+09:00",
      "network_id": ID_of_Network,
      "network_address": "192.168.0.0",
      "free": false,
      "id": ID_of_IPaddress,
      "gateway": "192.168.0.254"
    },
    "ID_of_IPaddress": {
      "address": "192.168.0.221",
      "disallowed_primary": false,
      "netmask": "255.255.255.0",
      "created_at": "2012-08-10T09:12:24+09:00",
      "broadcast": "192.168.0.255",
      "updated_at": "2012-08-10T09:12:24+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.220",
    "192.168.0.221"
  ],
  "type": "lb",
  "disks": {
    "ID_of_Disk": {
      "created_at": "2012-08-10T12:43:00+09:00",
      "add_to_linux_fstab": null,
      "disk_size": 5,
      "updated_at": "2012-08-10T12:43:07+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(LB),
      "has_autobackups": false,
      "built": true,
      "locked": false
    },
  },
  "disk": [
    5,
    1
  ],
  "disk_size": 6,
  "network_interfaces": {
    "ID_of_NetworkInterface": {
      "label": "LABEL-of-NetworkInterface",
      "created_at": "2012-08-10T12:43:01+09:00",
      "usage": null,
      "updated_at": "2012-08-10T12:43:01+09:00",
      "primary": true,
      "id": ID_of_NetworkInterface,
      "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_NetworkJoin,
      "virtual_machine_id": ID_of_VM(LB),
      "network_id": null
    }
  }
}

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

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

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

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

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

お問い合わせ