[Load Balancers] editCluster

editCluster

Summary of the Process by the Function

Edit the setting of load balance a cluster

Request Parameters

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

ParameterDescriptionRequired
cluster_id

Cluster ID

Specify Cluster ID
The cluster ID can be obtained through 13.1. listClusters function
It is the id of autoscaleout field or cluster field in the response object, 13.1. listCluster function

label

Label

In order to change the label set to a load balance cluster, specify the new label, the value after the change

・ Do not include this parameter in the request, when no change is required
・ One of label, rate_limit, or ports is a required parameter

( ○)
rate_limit

Bandwidth [Mbps]

Specifies the number you want to change about port speed set in the load balance cluster
The unit is in Mbps.

・ Do not include this parameter in the request, when no change is required
・ One of label, rate_limit, or ports will be required parameter

( ○)
ports

Port list[exa: 80,443]

Specifies a new port number after the change in order to change the port for cluster target set in the load balance cluster

・ Do not include this parameter in the request, when no change is required
・ When specifying more than one port numbers, separate them by comma
(Example: 80,8080,443,4443)
・ One of label, rate_limit, or ports will be required parameter

( ○)

Response Objects

If the request to edit the specified virtual server is successful then true is returned.
If the request to edit the specified virtual server failed then the resulting error message is returned.

Request Sample

https://api.gmocloud.com/Cloud-Zone-ID/?Action=editCluster&AccessKeyId=AccessKeyId&Version=1.0&cluster_id=ID_of_Cluster&label=LB-Label-example&rate_limit=1&ports=4443&Signature=Signature

Response Sample

true

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