[Load Balancers] listBalancers

listBalancers

Summary of the Process by the Function

Returns a list of load balancers

Request Parameters

There are no parameters to specify when executing this function.

Response Objects

Response will be in the following format.

FieldDescription
autoscaleout

Returns detailed information about the virtual server on which auto scaling type load balancer is running.

cluster

Returns detailed information about the virtual server on which clustering type load balancer is running.

allow_resize_without_reboot

Returns whether or not the number of CPU cores and memory size are changeable without restarting the load balancer

true : Size changeable without a restart
false : Any status except stated above

allowed_hot_migrate

Returns whether or not the load balancer is able to hot migrate

true : Hot migration possible
false : Any status except stated above

allowed_swap

Returns whether or not the load balancer can use swap disk

true : Swap disk can be used
false : Any status except stated above

booted

Returns the operation status of the load balancer

true : Load balancer is running
false : Any status except stated above

built

Returns build status of the load balancer

true : Build complete
false : Any status except stated above

cpu_shares

Returns CPU shares which are allocated to the load balancer

cpus

Returns the number of virtual CPU cores allocated to the load balancer

created_at

Returns the date and time of the load balancer creation
The date and time will be shown in the following format

YYYY-MM-DDThh:mm:ssZ

enable_autoscale

Returns the autoscale setting status on the load balancer

true : Auto scale setting complete
false : Any status except stated above

enable_monitis

Returns the operation status of the daemon, which monitors the status of auto scale on the load balancer

true : Enabled
false : Any status except stated above

hostname

Returns the host name set in the load balancer

hypervisor_id

Returns hypervisor ID load balancer uses

id

Returns load balancer ID

identifier

Returns the identifier of the load balancer

initial_root_password

Returns the initial root password of the load balancer

ip_addresses

Returns IP address allocated to the load balancer and its detailed information
Refer to section listIpAddresses for details included in this field.

ip

Returns a list of IP addresses allocated to the load balancers

label

Returns the label set to the load balancer

locked

Returns the lock status of the load balancer

true : Load balancer is locked
false : Any status except stated above

memory

Returns memory capacity allocated to the load balancer
The unit is in MB(Megabytes)

min_disk_size

Returns the minimum amount of disk space required by the template used in building the load balancer

note

Returns the note set in the load balancer

operating_system

Returns OS type used in the load balancer

operating_system_distro

Returns OS distribution type used when the load balancer was built

recovery_mode

Returns whether or not a load balancer can be started by recovery mode

true : Startable by recovery mode
false : The others

state

Returns operation status of the load balancer

on : Running
off : Stopped
pending : Waiting to be processed by cloud controller
running : In process by cloud controller

suspend

Returns whether or not the load balancer is stopped

true : Stopped
false : Any status except stated above

template_id

Returns template ID used when building a load balancer

template_label

Returns template label used when building a load balancer

total_disk_size

Returns disk capacity of all the disks allocated to the load balancer
The unit is in GB(Giga Bites)

type

Returns lb as virtual server type of the specified load balancer

updated_at

Returns the last update date and time of the specified load balancer settings
The date and time will be shown in the following format

YYYY-MM-DDThh:mm:ssZ


Request Sample

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

Response Sample

{
"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"
}
}
}

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.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk