[Load Balancers] getBalancer

getBalancer

Summary of the Process by the Function

Returns detailed information of the specified load balancer.
Returns an error when the specified load balancer ID is invalid or does not exist.

Request Parameters

Specify the following parameter(s) when executing this function.

ParameterDescriptionRequired
load_balancer_id

Load balancer ID

Specifies the identifier of the load balancer
The load balancer identifier can be obtained through 13.1. listBalancers
It is the id of autoscaleout field or cluster field in the response object, 13.1. listBalancers function

Identifier

Load balancer identifier

(This is identical to load_balancer_id, which is described later. This parameter will be abolished after some time)

Specifies the identifier of the load balancer
The load balancer identifier can be obtained through 13.1. listBalancers
It is the identifier of autoscaleout field or cluster field in the response object, 13.1. listBalancers function

×

 

Response Objects

Response will be in the following format.
Each element has the same structure as the response of listNode function.

FieldDescription
lb

Returns detailed information of the load balancer

Refer to response object in listBalancer function for details.

Request Sample

https://api.gmocloud.com/Cloud-Zone-Id/?Action=getBalancer&AccessKeyId=AccessKeyId&Version=1.0&Identifier=Identifier_of_LoadBalancer&Signature=Signature

Response Sample

{
"cpus": 1,
"label": "LABEL_of_LB",
"created_at": "2012-08-10T12:43:00+09:00",
"operating_system_distro": "lbva",
"cpu_shares": 10,
"enable_autoscale": NULL,
"operating_system": "linux",
"template_id": ID_of_Template,
"allowed_swap": true,
"memory": 512,
"updated_at": "2012-08-10T13:02:34+09:00",
"allow_resize_without_reboot": false,
"recovery_mode": NULL,
"enable_monitis": false,
"hypervisor_id": ID_of_Hypervisor,
"id": ID_of_Loadbalancer,
"allowed_hot_migrate": true,
"note": NULL,
"suspended": false,
"booted": true,
"hostname": "loadbalancer.example.com",
"template_label": "Load Balancer Virtual Appliance",
"total_disk_size": 6,
"add_to_marketplace": NULL,
"identifier": "Identifier_of_LB",
"initial_root_password": "Password_of_LB",
"min_disk_size": 5,
"built": true,
"locked": false,
"state": "on",
"ip_addresses": {
"ID_of_IPaddress": {
"address": "192.168.0.220",
"disallowed_primary": false,
"netmask": "255.255.255.0",
"created_at": "2012-08-10T09:12:24+09:00",
"broadcast": "192.168.0.255",
"updated_at": "2012-08-10T09:12:24+09:00",
"network_id": ID_of_Network,
"network_address": "192.168.0.0",
"free": false,
"id": ID_of_IPaddress,
"gateway": "192.168.0.254"
},
"ID_of_IPaddress": {
"address": "192.168.0.221",
"disallowed_primary": false,
"netmask": "255.255.255.0",
"created_at": "2012-08-10T09:12:24+09:00",
"broadcast": "192.168.0.255",
"updated_at": "2012-08-10T09:12:24+09:00",
"network_id": ID_of_Network,
"network_address": "192.168.0.0",
"free": false,
"id": ID_of_IPaddress,
"gateway": "192.168.0.254"
}
},
"ip": [
"192.168.0.220",
"192.168.0.221"
],
"type": "lb",
"disks": {
"ID_of_Disk": {
"created_at": "2012-08-10T12:43:00+09:00",
"add_to_linux_fstab": NULL,
"disk_size": 5,
"updated_at": "2012-08-10T12:43:07+09:00",
"primary": true,
"data_store_id": ID_of_DataStore,
"id": ID_of_Disk,
"disk_vm_number": 1,
"is_swap": false,
"mount_point": NULL,
"identifier": "Identifier_of_Disk",
"virtual_machine_id": ID_of_VM(LB),
"has_autobackups": false,
"built": true,
"locked": false
},
},
"disk": [
5,
1
],
"disk_size": 6,
"network_interfaces": {
"ID_of_NetworkInterface": {
"label": "LABEL-of-NetworkInterface",
"created_at": "2012-08-10T12:43:01+09:00",
"usage": NULL,
"updated_at": "2012-08-10T12:43:01+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(LB),
"network_id": NULL
}
}
}

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