listClusters
Summary of the Process by the Function
Returns a list of load balancers consisting a load balance cluster and virtual servers.
Request Parameters
There are no parameters to specify when executing this function.
Response Objects
Response will be in the following format.
Field | Description |
---|---|
autoscaleout |
Returns detailed information about the auto scaling type load balance cluster. |
cluster |
Returns detailed information about the clustering type load balance cluster. |
auto_scaling_in_cpu |
Returns the set value of auto scale in by CPU usage created_at : Date and time the setting was made |
auto_scaling_in_memory |
Returns the set value of auto scale in by remaining memory created_at : Date and time the setting was made |
auto_scaling_out_cpu |
Returns the set value of auto scale out by CPU usage created_at : Date and time the setting was made |
auto_scaling_out_memory |
Returns the set value of auto scale out by remaining memory created_at : Date and time the setting was made |
cluster_type |
Returns the type of the load balance cluster autoscaleout : autoscale |
config |
Returns the set value for cluster node in the auto scaling type load balancer max_node_amount : Set value as the maximum number of nodes |
created_at |
Returns the date and time of the load balance cluster creation YYYY-MM-DDThh:mm:ssZ |
id |
Returns cluster ID |
identifier |
Returns cluster identifier |
image_template_id |
Returns template ID used when load balance cluster was created |
load_balancer_id |
Returns load balancer ID |
load_balancer_password |
Returns root password when logging into load balancer administration screen |
load_balancer |
Returns detailed information about load balancer belonging to load balance cluster |
name |
Returns label set in load balancer |
nodes |
Returns information for cluster nodes belonging to the load balance cluster cluster_id : ID of the cluster the node belongs to |
node_attributes |
Returns resource allocation value of the cluster node cpu_shares : CPU usage(%) |
ports |
Returns the port number for load balancing |
updated_at |
Returns the last update date and time of the load balancer cluster setting YYYY-MM-DDThh:mm:ssZ |
Request Sample
https://api.gmocloud.com/Cloud-Zone-ID/?Action=listClusters&AccessKeyId=AccessKeyId&Version=1.0&Signature=Signature
Response Sample
{
"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
},
}
}
Note: GMO CLOUD AMERICA INC. does not make any guarantee with regard to the content of this manual and will not be held responsible for any damages resulting from customers or third parties.
0 Comments