changeLoadBalancerInstanceConfiguration

Article Summary

Share feedback

Thanks for sharing your feedback!

Can be used in a Classic environment.

Overview

Changes the settings of a load balancer instance.

Description

Changes the settings value of a load balancer instance.

Request parameter

Parameter name	Requirement status	Type	Restrictions	Description
loadBalancerInstanceNo	Yes	String		- The number for the load balancer instance to change the settings for The instance number can be obtained through the getLoadBalacerInstanceList action.
loadBalancerAlgorithmTypeCode	Yes	String	Min: 1, Max: 5	- Load balancer algorithm classification code Algorithms that can be entered: ROUND ROBIN (RR), LEAST_CONNECTION (LC)
loadBalancerDescription	No	String	Min: 1, Max: 1000	Description of the load balancer to modify
loadBalancerRuleList.protocolTypeCode	Yes	String	Min: 1, Max: 5	- Protocol classification code of the load balancer rule The following codes can be entered: HTTP \| TCP
loadBalancerRuleList.loadBalancerPort	Yes	Integer	Min: 1, Max: 65534	Load balancer port of the load balancer rule
loadBalancerRuleList.serverPort	Yes	Integer	Min: 1, Max: 65534	Server port for the load balancer rule
loadBalancerRuleList.l7HealthCheckPath	Conditional	String	Min: 1, Max: 600	- Health check path for the load balancer rule Required field if the loadBalancerRuleList.N.protocolTypeCode value is HTTP
loadBalancerRuleList.certificateName	Conditional	String	Min: 1, Max: 300	The load balancer rule must be entered when creating a load balancer. Load balancer's SSL public certificate Required field if the loadBalancerRuleList.protocloTypeCode value is SSL/HTTPS
loadBalancerRuleList.proxyProtocolUseYn	Conditional	String	Min: 1, Max: 300	Load balancer rule list.Proxy protocol use status
loadBalancerRuleList.N.stickySessionUseYn	No	String		- Access by session usage status It can only be set when the loadBalancerRuleList.N.protocloTypeCode value is `HTTP` `HTTPS`. Options: `Y (enabled)`\|`N (disabled)`
loadBalancerRuleList.N.http2UseYn	No	String		- HTTP/2 protocol use status It can only be set when the loadBalancerRuleList.N.protocloTypeCode value is `HTTPS`. Options: `Y (enabled)`\|`N (disabled)`
loadBalancerRuleList.N.serverProtocolTypeCode	No	String		- Server protocol classification code It can only be set when the loadBalancerRuleList.N.protocloTypeCode value is `HTTPS`. Options: `HTTP` `HTTPS` Default: `HTTP`

Response data type

LoadBalancerInstanceList type

LoadBalancerInstanceList extends CommonResponse
private Integer totalRows;
private List<LoadBalancerInstance> loadBalancerInstanceList = new ArrayList<LoadBalancerInstance>();

LoadBalancerInstance
private String loadBalancerInstanceNo;
private String virtualIp;
private String loadBalancerName;
private CommonCode loadBalancerAlgorithmType;
private String loadBalancerDescription;
private Date createDate;
private String domainName;
private String loadBalancerInstanceStatusName;
private CommonCode loadBalancerInstanceStatus;
private CommonCode loadBalancerInstanceOperation;
private CommonCode networkUsageType;
private Boolean isHttpKeepAlive;
private Integer connectionTimeout;
private String certificateName;
private List loadBalancerRuleList;
private List loadBalancedServerInstanceList;

Examples

Call

ncloud loadbalancer changeLoadBalancerInstanceConfiguration --loadBalancerInstanceNo 465475 --loadBalancerAlgorithmTypeCode RR --loadBalancerRuleList protocolTypeCode=HTTP,loadBalancerPort=80,serverPort=1024,l7HealthCheckPath=/l7check.html,proxyProtocolUseYn=N

Response

{
  "changeLoadBalancerInstanceConfigurationResponse": {
    "requestId": "962fa0f6-b7b3-4d33-8567-862f33c87771",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "loadBalancerInstanceList": [
     {
       "loadBalancerInstanceNo": 465475,
       "virtualIp": "49.236.164.49,49.236.164.68",
       "loadBalancerName": "penguinlb",
       "loadBalancerAlgorithmType": {
         "code": "RR",
         "codeName": "Round Robin"
       },
       "loadBalancerDescription": "",
       "createDate": "0518-12-03T12:25:18+0900",
       "domainName": "slb-465475.ncloudslb.com",
       "loadBalancerInstanceStatusName": "changing",
       "loadBalancerInstanceStatus": {
         "code": "USED",
         "codeName": "NET USED state"
       },
       "loadBalancerInstanceOperation": {
         "code": "CHANG",
         "codeName": "NET CHANGE OP"
       },
       "networkUsageType": {
         "code": "PBLIP",
         "codeName": "Public"
       },
       "isHttpKeepAlive": false,
       "connectionTimeout": 60,
       "certificateName": "",
       "loadBalancerRuleList": [
         {
             "protocolType": {
               "code": "HTTP",
               "codeName": "http"
             },
             "loadBalancerPort": 80,
             "serverPort": 1024,
             "l7HealthCheckPath": "/l7check.html",
             "certificateName": "",
             "proxyProtocolUseYn": "N",
             "stickySessionUseYn": "N",
             "http2UseYn": "N"
         }
       ],
       "loadBalancedServerInstanceList": [
         ""
       ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<changeLoadBalancerInstanceConfigurationResponse>
  <requestId>962fa0f6-b7b3-4d33-8567-862f33c87771</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerInstanceList>
    <loadBalancerInstanceNo>465475</loadBalancerInstanceNo>
    <virtualIp>49.236.164.49,49.236.164.68</virtualIp>
    <loadBalancerName>penguinlb</loadBalancerName>
    <loadBalancerAlgorithmType>
      <code>RR</code>
      <codeName>Round Robin</codeName>
    </loadBalancerAlgorithmType>
    <loadBalancerDescription></loadBalancerDescription>
    <createDate>0518-12-03T12:25:18+0900</createDate>
    <domainName>slb-465475.ncloudslb.com</domainName>
    <loadBalancerInstanceStatusName>changing</loadBalancerInstanceStatusName>
    <loadBalancerInstanceStatus>
      <code>USED</code>
      <codeName>NET USED state</codeName>
    </loadBalancerInstanceStatus>
    <loadBalancerInstanceOperation>
      <code>CHANG</code>
      <codeName>NET CHANGE OP</codeName>
    </loadBalancerInstanceOperation>
    <networkUsageType>
      <code>PBLIP</code>
      <codeName>Public</codeName>
    </networkUsageType>
    <isHttpKeepAlive>false</isHttpKeepAlive>
    <connectionTimeout>60</connectionTimeout>
    <certificateName></certificateName>
    <loadBalancerRuleList>
      <protocolType>
        <code>HTTP</code>
        <codeName>http</codeName>
      </protocolType>
      <loadBalancerPort>80</loadBalancerPort>
      <serverPort>1024</serverPort>
      <l7HealthCheckPath>/l7check.html</l7HealthCheckPath>
      <certificateName></certificateName>
      <proxyProtocolUseYn>N</proxyProtocolUseYn>
      <stickySessionUseYn>N</stickySessionUseYn>
      <http2UseYn>N</http2UseYn>
    </loadBalancerRuleList>
    <loadBalancedServerInstanceList></loadBalancedServerInstanceList>
  </loadBalancerInstanceList>
</changeLoadBalancerInstanceConfigurationResponse>

Was this article helpful?

What's Next

getLoadBalancedServerInstanceList

Table of contents

Overview
Description
Request parameter
Response data type
Examples