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

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

listBalancers

機能の処理概要

ロードバランサー一覧の表示

ロードバランサーの一覧を返します

リクエストパラメーター

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

レスポンスオブジェクト

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

フィールド 説明
autoscaleout オートスケーリングタイプのロードバランサーが稼動している仮想サーバーの詳細情報を返します
cluster クラスタリングタイプのロードバランサーが稼動している仮想サーバーの詳細情報を返します
allow_resize_without_reboot ロードバランサーを再起動せずにCPUコア数とメモリサイズの変更ができるか否かを返します

true : 再起動せずにサイズ変更可能
false : 上記以外の状態
allowed_hot_migrate ロードバランサーがホットマイグレーションをすることができるか否かを返します

true : ホットマイグレーションが可能
false : 上記以外の状態
allowed_swap ロードバランサーでスワップディスクの使用ができるか否かを返します

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_addresses ロードバランサーに割り当てられているIPアドレスとその詳細情報を返します
このフィールドに含まれるパラメーターの詳細は listIpAddresses 項をご参照ください
ip ロードバランサーに割り当てられているIPアドレスの一覧を返します
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 : 停止中
pending : クラウドコントローラーによる処理待ち
running : クラウドコントローラーによる処理中
suspend ロードバランサーが停止中の状態か否かを返します

true : 停止中の状態
false : 上記以外の状態
template_id ロードバランサー構築時に利用したテンプレートのIDを返します
template_label ロードバランサー構築時に利用したテンプレートのラベルを返します
total_disk_size ロードバランサーに割り当てられている全てのディスクのディスク容量を返します
単位はGB(Giga Bites) です
type 指定したロードバランサーの仮想サーバー種別として lb を返します
updated_at 指定したロードバランサーの設定が最後にアップデートされた日時を返します
日時は下記のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ

リクエストサンプル

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

レスポンスサンプル

{
  "cluster": {
    "ID_of_LB": {
      "label": "LB-Label-example",
      "cpus": 1,
      "operating_system_distro": "lbva",
      "created_at": "2012-08-22T12:45:13+09:00",
      "template_id": ID_of_Template,
      "operating_system": "linux",
      "enable_autoscale": null,
      "cpu_shares": 10,
      "updated_at": "2012-08-23T09:58:20+09:00",
      "memory": 512,
      "allowed_swap": true,
      "recovery_mode": null,
      "allow_resize_without_reboot": false,
      "id": ID_of_LB,
      "hypervisor_id": ID_of_HV,
      "enable_monitis": false,
      "allowed_hot_migrate": true,
      "suspended": false,
      "note": null,
      "total_disk_size": 6,
      "template_label": "Load Balancer Virtual Appliance",
      "hostname": "gmocloud1.example.com",
      "booted": true,
      "min_disk_size": 5,
      "initial_root_password": "Password",
      "identifier": "Identifier_of_LB",
      "ip_addresses": {
        "ID_of_IpAddress": {
          "netmask": "255.255.255.0",
          "disallowed_primary": false,
          "address": "192.168.0.100",
          "created_at": "2012-08-17T17:30:35+09:00",
          "network_address": "192.168.0.0",
          "network_id": ID_of_Network,
          "updated_at": "2012-08-17T17:30:35+09:00",
          "broadcast": "192.168.0.255",
          "id": ID_of_IpAddress,
          "free": false,
          "gateway": "192.168.0.254"
        },
        "ID_of_IpAddress": {
          "netmask": "255.255.255.0",
          "disallowed_primary": false,
          "address": "192.168.0.101",
          "created_at": "2012-08-17T17:30:35+09:00",
          "network_address": "192.168.0.0",
          "network_id": ID_of_Network,
          "updated_at": "2012-08-17T17:30:35+09:00",
          "broadcast": "192.168.0.255",
          "id": ID_of_IpAddress,
          "free": false,
          "gateway": "192.168.0.254"
        }
      },
      "state": "on",
      "locked": false,
      "built": true,
      "ip": [
        "192.168.0.100",
        "192.168.0.101"
      ],
      "type": "lb"
    }
  },
  "autoscaleout": {
    "ID_of_LB": {
      "label": "LB-Label-example",
      "cpus": 1,
      "operating_system_distro": "lbva",
      "created_at": "2012-08-22T12:48:26+09:00",
      "template_id": ID_of_Template,
      "operating_system": "linux",
      "enable_autoscale": null,
      "cpu_shares": 10,
      "updated_at": "2012-08-23T09:58:20+09:00",
      "memory": 512,
      "allowed_swap": true,
      "recovery_mode": null,
      "allow_resize_without_reboot": false,
      "id": ID_of_LB,
      "hypervisor_id": ID_of_HV,
      "enable_monitis": false,
      "allowed_hot_migrate": true,
      "suspended": false,
      "note": null,
      "total_disk_size": 6,
      "template_label": "Load Balancer Virtual Appliance",
      "hostname": "gmocloud2.example.com",
      "booted": true,
      "min_disk_size": 5,
      "initial_root_password": "Password",
      "identifier": "Identifier_of_LB",
      "ip_addresses": {
        "ID_of_IpAddress": {
          "netmask": "255.255.255.0",
          "disallowed_primary": false,
          "address": "192.168.0.102",
          "created_at": "2012-08-17T17:30:35+09:00",
          "network_address": "192.168.0.0",
          "network_id": ID_of_Network,
          "updated_at": "2012-08-17T17:30:35+09:00",
          "broadcast": "192.168.0.255",
          "id": ID_of_IpAddress,
          "free": false,
          "gateway": "192.168.0.254"
        },
        "ID_of_IpAddress": {
          "netmask": "255.255.255.0",
          "disallowed_primary": false,
          "address": "192.168.0.103",
          "created_at": "2012-08-17T17:30:35+09:00",
          "network_address": "192.168.0.0",
          "network_id": ID_of_Network,
          "updated_at": "2012-08-17T17:30:35+09:00",
          "broadcast": "192.168.0.255",
          "id": ID_of_IpAddress,
          "free": false,
          "gateway": "192.168.0.254"
        }
      },
      "state": "on",
      "locked": false,
      "built": true,
      "ip": [
        "192.168.0.102",
        "192.168.0.103"
      ],
      "type": "lb"
    }
  }
}

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

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

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

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

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

お問い合わせ