[Load Balancers] deployAutoScalingBalancer

deployAutoScalingBalancer

Summary of the Process by the Function

Creates an auto scale type load balancer

Request Parameters

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

ParameterDescriptionRequired
autoscaling_in_cpu

Node deleting CPU condition[Duration Time,Deleting number of nodes,CPU load[%]]

Specifies conditions when auto scale in according to CPU load
Use comma to separate condition parameters

×

autoscaling_in_memory

Memory condition for node deletion[Duration Time,Deleting number of nodes,Remaining memory[MB]]

Specifies conditions when auto scale in according to remaining memory
Use comma to separate condition parameters

×
autoscaling_out_cpu

CPU condition for node addition[Duration Time,Additional number of nodes,CPU load[%]]

Specifies conditions when auto scale out according to CPU load

Use comma to separate condition parameters

×
autoscaling_out_memory

Memory condition for node addition[Duration Time,Additional number of nodes,Remaining memory[MB]]

Specifies conditions when auto scale out according to remaining memory

Use comma to separate condition parameters

×
label

Label

Specifies a label to be set in the load balancer

hostname

Host name

Specifies hostname of the load balancer to be integrated

hypervisor_group_id

Hypervisor group ID

Specifies hypervisor group ID allocated to the hypervisor consisting of the virtual server which creates the load balancer
When not specifying a hypervisor group ID, a load balancer will be created in one of the hypervisors which are available in GMO Cloud Hosting
The hypervisor group ID can be obtained through 3.1. listHypervisors function
It is the hypervisor_group_id in the response object, 3.1. listHypervisors function

×
hypervisor_id

Hypervisor ID

Specifies hypervisor ID consisting of the virtual server which creates the load balancer
When not specifying hypervisor ID, it will be created in the hypervisor with the most remaining memory capacity within all the hypervisor in GMO Cloud Hosting.
The hypervisor ID can be obtained through 3.1. listHypervisors function
It is the id in the response object, 3.1. listHypervisors function

×
max_node_amount

The maximum number of nodes

Specifies the maximum number of nodes of the virtual server integrated by auto scale out

min_node_amount

The minimum number of nodes

Specifies the minimum number of virtual servers which will remain when deleting nodes by auto scale in

node_cpu_shares

Node CPU shares

Specifies a CPU share allocated to the virtual server to be integrated by auto scale out
When not specifying this parameter, the initial value is 1

The unit is in % (Percent).

×
node_cpus

Node CPU cores

Specifies the number of virtual CPU cores allocated to the virtual server integrated by auto scale out

The unit is in unit.

node_memory

Node memory [MB]

Specifies the memory capacity allocated to the virtual server integrated by auto scale out

The unit is in MB(Megabytes).

node_rate_limit

Node bandwidth [Mbps]

Specifies the port speed of the network allocated the virtual server integrated by auto scale out

The unit is in Mbps.

node_template_id

Template ID

Specifies the template ID used by the virtual server integrated by auto scale out

The system template and user template IDs can be obtained through 11.1. listImages function
It is the id in the response object, 11.1. listImages

primary_network_group_id

Network group ID

Specifies network group ID allocated to the virtual server to be integrated
The network group ID can be obtained through 8.1. listNetworks function
It is the network_group_id in the response object, 8.1. listNetworks function

×
rate_limit

Bandwidth [Mbps]

Specifies a port speed of the network allocated to load balancer to be integrated
The unit is in Mbps.

ports

Port list [ex. 80,443]

Specifies cluster target ports set in the load balancer to be integrated

When specifying more than one port numbers, separate them by comma
(Example: 80,8080,443,4443)

Response Objects

When the request in creating the specified load balancer is successful, responses will be in the following format

FieldDescription
cluster_id

When the request in creating load balancer is successful, it returns cluster_id to be allocated to the load balancer

Return a relevant error message when failed in request for creating the specified load balancer.

Request Sample

https://api.gmocloud.com/Cloud-Zone-ID/?Action=deployAutoScalingBalancer&AccessKeyId=AccessKeyId&Version=1.0&label=LB-Label-example&hostname=gmocloud.example.com&rate_limit=1&ports=80%2C443&node_cpus=1&node_memory=128&node_rate_limit=1&node_template_id=ID_of_Template&max_node_amount=2&min_node_amount=1&auto_scaling_in_cpu=20%2C1%2C90&auto_scaling_in_memory=20%2C1%2C42&auto_scaling_out_cpu=5%2C1%2C1&auto_scaling_out_memory=5%2C1%2C1&hypervisor_group_id=ID_of_HV-Group&hypervisor_id=ID_of_HV&node_cpu_shares=1&primary_network_group_id=ID_of_NetworkGroup&Signature=Signature

Response Sample

{
"cluster_id": ID_of_Cluster
}

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