[Load Balancers] deployClusteringBalancer

deployClusteringBalancer

Summary of the Process by the Function

Creates a cluster type load balancer

Request Parameters

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

ParameterDescriptionRequired
label

Label

Specifies the label set in the load balancer.

hostname

Host name

Specifies the hostname of load balancer to be integrated

hypervisor_group_id

Hypervisor group ID

Specifies hypervisor ID allocated to the hypervisor consisting of a virtual server which created load balancer.
When not specifying the 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 a 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

×
nodes

VM identifier list [ex. ABC:IP,XYZ]

Specifies a virtual server which is set in the load balancer to be integrated

When specifying more than one virtual servers, separate them by comma
(Example: abc123def456gh,9zyx8wvu7ts)

×
primary_network_group_id

Network group ID

Specifies the network group ID allocated to the virtual server which is 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 network allocated to the load balancer to be integrated
The unit is in Mbps.

x
ports

Port list [ex. 80,443]

Specifies cluster target port 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 a specified load balancer is successful, the responses will be in the following format

FieldDescription
cluster_id

When the request in creating a 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=deployClusteringBalancer&AccessKeyId=AccessKeyId&Version=1.0&label=Cluster-Label-example&hostname=gmocloud.example.com&hypervisor_group_id=ID_of_HV-Group&hypervisor_id=ID_of_HV&primary_network_group_id=ID_of_NetworkGroup&rate_limit=1&ports=80%2C443&nodes=abc123def456gh%2C9zyx8wvu7ts&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