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

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

getCluster

機能の処理概要

個別のロードバランスクラスターの詳細情報の取得

指定したロードバランスクラスターの詳細情報を返します。

リクエストパラメーター

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

パラメーター 説明 必須
cluster_id クラスタID

クラスターIDを指定します
クラスターIDは13.1. listClusters APIで取得できます
13.1. listCluster APIのレスポンスオブジェクトのうち、autoscaleoutフィールドもしくはclusterフィールドの id が該当します

レスポンスオブジェクト

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

フィールド 説明
network_interfaces 指定したロードバランサーに設定されているネットワークインターフェースの詳細情報を返します
このフィールドに含まれるパラメーターの詳細は 7.1. listNetworkInterfaces 項をご参照ください

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

リクエストサンプル

https://api.gmocloud.com/Cloud-Zone-Id/?Action=getCluster&AccessKeyId=AccessKeyId&Version=1.0&cluster_id=ID_of_Cluster&Signature=Signature

レスポンスサンプル

{
  "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_LB,
  "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_Cluster,
    "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_Cluster",
    "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": "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.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",
    "network_interfaces": {
      "ID_of_NetworkInterface": {
        "label": "NetworkInterface-Label-example",
        "created_at": "2012-08-22T12:48:26+09:00",
        "usage": null,
        "updated_at": "2012-08-22T12:48:26+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,
        "network_id": null
      }
    }
  },
  "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_AutoScale,
    "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_AutoScale,
    "enabled": true,
    "value": 42
  },
  "nodes": {
    "ID_of_AutoScale": {
      "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_AutoScale,
      "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_AutoScale,
    "enabled": true,
    "value": 50
  },
  "image_template_id": ID_of_Template
}

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

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

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

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

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

お問い合わせ