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

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

listClusters

機能の処理概要

ロードバランスクラスター一覧の表示

ロードバランスクラスターを構成するロードバランサーと仮想サーバーの一覧を返します

リクエストパラメーター

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

レスポンスオブジェクト

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

フィールド 説明
autoscaleout オートスケーリングタイプのロードバランスクラスターの詳細情報を返します
cluster クラスタリングタイプのロードバランスクラスターの詳細情報を返します
auto_scaling_in_cpu CPU利用率によるオートスケールインの設定値を返します

created_at : 設定を行った日時
enebled : true の場合、設定が有効な状態
false の場合、設定が無効な状態
for_minutes : オートスケール判定時間間隔(分)
id : オートスケール設定ID
units : 削除する仮想サーバーの個数
updated_at : 設定の最終変更日時
value : オートスケール判定のCPU利用率(%)の閾値
auto_scaling_in_memory メモリー残領域によるオートスケールインの設定値を返します

created_at : 設定を行った日時
enebled : true の場合、設定が有効な状態
false の場合、設定が無効な状態
for_minutes : オートスケール判定時間間隔(分)
id : オートスケール設定ID
units : 削除する仮想サーバーの個数
updated_at : 設定の最終変更日時
value : オートスケール判定のメモリー残領域サイズ(MB)の閾値
auto_scaling_out_cpu CPU利用率によるオートスケールアウトの設定値を返します

created_at : 設定を行った日時
enebled : true の場合、設定が有効な状態
false の場合、設定が無効な状態
for_minutes : オートスケール判定時間間隔(分)
id : オートスケール設定ID
units : 追加する仮想サーバーの個数
updated_at : 設定の最終変更日時
value : オートスケール判定のCPU利用率(%)の閾値
auto_scaling_out_memory メモリー残領域によるオートスケールアウトの設定値を返します

created_at : 設定を行った日時
enebled : true の場合、設定が有効な状態
false の場合、設定が無効な状態
for_minutes : オートスケール判定時間間隔(分)
id : オートスケール設定ID
units : 追加する仮想サーバーの個数
updated_at : 設定の最終変更日時
value : オートスケール判定のメモリー残領域サイズ(MB)の閾値
cluster_type ロードバランスクラスターの種別を返します

autoscaleout : オートスケール
cluster : クラスタリング(クラスター)
config オートスケーリングタイプのロードバランサーの、クラスターノードの設定値を返します

max_node_amount : 最大ノード数の設定値
min_node_amount : 最小ノード数の設定値
created_at ロードバランスクラスターの作成日時を返します
日時は下記のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ
id クラスターIDを返します
identifier クラスター識別子を返します
image_template_id ロードバランスクラスターの構築時に利用したテンプレートのIDを返します
load_balancer_id ロードバランサーのIDを返します
load_balancer_password ロードバランサーの管理画面にログインする際の root のパスワードを返します
load_balancer ロードバランスクラスターに属するロードバランサーの詳細情報を返します
このフィールドに含まれるパラメーターの詳細は 13.11. listBalancers 項をご参照ください
name ロードバランサーに設定されているラベルを返します
nodes ロードバランスクラスターに属するノードの情報を返します

cluster_id : ノードが属するクラスターのID
created_at : ノードが作成された日時
id : ノードID
ip_address_id : ノードに割り当てられているIPアドレスID
updated_at : ノードの情報の最終更新日時
virtual_machine_id : ロードバランサー本体となる仮想サーバーのID
node_attributes クラスターノードのリソース割り当て値を返します

cpu_shares : CPU占有率(%)
cpus : 仮想CPUコア数
memory : メモリ容量(MB)
rate_limit : ポートスピード(Mbps)
ports ロードバランシング対象のポート番号を返します
updated_at ロードバランスクラスターの設定が最後にアップデートされた日時を返します
日時は下記のフォーマットで表されます

YYYY-MM-DDThh:mm:ssZ

リクエストサンプル

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

レスポンスサンプル

{
  "cluster": {
    "ID_of_Cluster": {
      "name": "Cluster-Label-example",
      "created_at": "2012-08-22T12:45:13+09:00",
      "config": {
        "max_node_amount": "",
        "min_node_amount": ""
      },
      "load_balancer_id": ID_of_LB,
      "load_balancer_password": "Password",
      "updated_at": "2012-08-22T12:45:13+09:00",
      "auto_scaling_out_cpu": null,
      "id": ID_of_Cluster,
      "load_balancer": {
        "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-23T21:29:02+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": false,
        "min_disk_size": 5,
        "initial_root_password": "Password",
        "identifier": "Identifier_of_LB",
        "ip_addresses": {
          "ID_of_IpAdress": {
            "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": "off",
        "locked": false,
        "built": true,
        "ip": [
          "192.168.0.100",
          "192.168.0.101"
        ],
        "type": "lb"
      },
      "auto_scaling_out_memory": null,
      "ports": [
        80
      ],
      "auto_scaling_in_memory": null,
      "nodes": {
        "ID_of_Node": {
          "cluster_id": ID_of_Cluster,
          "ip_address_id": ID_of_IpAddress,
          "created_at": "2012-08-22T12:45:13+09:00",
          "updated_at": "2012-08-22T12:45:13+09:00",
          "id": ID_of_Node,
          "virtual_machine_id": ID_of_Cluster-VM
        },
        "ID_of_Node": {
          "cluster_id": ID_of_Cluster,
          "ip_address_id": ID_of_IpAddress,
          "created_at": "2012-08-22T12:45:13+09:00",
          "updated_at": "2012-08-22T12:45:13+09:00",
          "id": ID_of_Node,
          "virtual_machine_id": ID_of_Cluster-VM
        }
      },
      "cluster_type": "cluster",
      "identifier": "Identifier_of_Cluster",
      "node_attributes": null,
      "auto_scaling_in_cpu": null,
      "image_template_id": null
    }
  },
  "autoscaleout": {
    "ID_of_Cluster": {
      "name": "Cluster-Label-example",
      "created_at": "2012-08-22T12:48:26+09:00",
      "config": {
        "max_node_amount": 3,
        "min_node_amount": 1
      },
      "load_balancer_id": ID_of_LB,
      "load_balancer_password": "Password",
      "updated_at": "2012-08-22T13:30:18+09:00",
      "auto_scaling_out_cpu": {
        "for_minutes": 5,
        "created_at": "2012-08-22T12:48:26+09:00",
        "updated_at": "2012-08-22T13:30:18+09:00",
        "units": 1,
        "id": ID_of_AutoScale,
        "enabled": true,
        "value": 100
      },
      "id": ID_of_Cluster,
      "load_balancer": {
        "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-23T21:29:04+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.110",
            "created_at": "2012-08-17T17:30:35+09:00",
            "network_address": "211.125.78.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.111",
            "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.110",
          "192.168.0.111"
        ],
        "type": "lb"
      },
      "auto_scaling_out_memory": {
        "for_minutes": 5,
        "created_at": "2012-08-22T12:48:26+09:00",
        "updated_at": "2012-08-22T13:30:18+09:00",
        "units": 1,
        "id": ID_of_AutScaling,
        "enabled": true,
        "value": 1
      },
      "ports": [
        443
      ],
      "auto_scaling_in_memory": {
        "for_minutes": 20,
        "created_at": "2012-08-22T12:48:26+09:00",
        "updated_at": "2012-08-22T12:48:26+09:00",
        "units": 1,
        "id": ID_of_AutoScaling,
        "enabled": true,
        "value": 42
      },
      "nodes": {
        "ID_of_Node": {
          "cluster_id": ID_of_Cluster,
          "ip_address_id": ID_of_IpAddress,
          "created_at": "2012-08-22T12:48:28+09:00",
          "updated_at": "2012-08-22T12:48:28+09:00",
          "id": ID_of_Node,
          "virtual_machine_id": ID_of_VM
        }
      },
      "cluster_type": "autoscaleout",
      "identifier": "Identifier_of_Cluster",
      "node_attributes": {
        "cpus": "1",
        "cpu_shares": "5",
        "memory": "128",
        "rate_limit": "1"
      },
      "auto_scaling_in_cpu": {
        "for_minutes": 20,
        "created_at": "2012-08-22T12:48:26+09:00",
        "updated_at": "2012-08-22T13:07:35+09:00",
        "units": 1,
        "id": ID_of_AutoScaling,
        "enabled": true,
        "value": 50
      },
      "image_template_id": ID_of_Template
    },
  }
}

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

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

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

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

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

お問い合わせ