changeLoadBalancerInstanceConfiguration
- Print
- PDF
changeLoadBalancerInstanceConfiguration
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a Classic environment.
Overview
Change load balancer instance's rule settings value.
Request
Request header
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | It indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. |
| x-ncp-apigw-api-key | Key issued from API Gateway (no need to enter in the v2 version) |
| x-ncp-iam-access-key | API key issued by NAVER Cloud Platform or access key issued by IAM |
| x-ncp-apigw-signature-v2 | A signature that encrypts the body with secret key mapped to the access key HmacSHA256 is used for HMAC encryption algorithm. |
Request parameter
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| loadBalancerInstanceNo | Yes | String | - The load balancer instance number to change settings You can find out the instance number through the getLoadBalancerInstanceList action. | |
| loadBalancerAlgorithmTypeCode | Yes | String | Min : 1,Max : 5 | Algorithms that can be entered: RR(ROUND ROBIN), LC(LEAST_CONNECTION) |
| loadBalancerDescription | No | String | Min : 1,Max : 1000 | Description of the load balancer to modify |
| loadBalancerRuleList.N.protocolTypeCode | Yes | String | Min : 1, Max : 5 | Enter the protocol type code in the load balancer rule. The following codes can be used for protocol type code: HTTP HTTPS TCP |
| loadBalancerRuleList.N.loadBalancerPort | Yes | Integer | Min : 1, Max : 65534 | It sets load balancer ports in the load balancer rule. Load balancer ports in one load balancer must not overlap. Ports 22, 3389, 64000, 65130, 65131, and 18080 - 18095 can't be used since they're reserved for load balancer management. |
| loadBalancerRuleList.N.serverPort | Yes | Integer | Min : 1, Max : 65534 | - Server port in the load balancer rule Server port overlaps in one load balancer are allowed. |
| loadBalancerRuleList.N.l7HealthCheckPath | Conditional | String | Min : 1, Max : 600 | - Health check path of the load balancer rule Required if the loadBalancerRuleList.N.protocolTypeCode value is HTTP HTTPS. |
| loadBalancerRuleList.N.certificateName | Conditional | String | Min : 1, Max : 300 | Enter the load balancer's SSL public certificate name. Required if the loadBalancerRuleList.N.protocolTypeCode value is SSL HTTPS. |
| loadBalancerRuleList.N.proxyProtocolUseYn | No | String | - Proxy protocol usage status It can be set only when the loadBalancerRuleList.N.protocolTypeCode value is TCP SSL.Options: Y (enabled)|N (disabled) | |
| loadBalancerRuleList.N.stickySessionUseYn | No | String | - Access by session usage status It can be set only when the loadBalancerRuleList.N.protocolTypeCode value is HTTP HTTPS.Options: Y (enabled)|N (disabled) | |
| loadBalancerRuleList.N.http2UseYn | No | String | - HTTP/2 protocol usage status It can be set only when the loadBalancerRuleList.N.protocolTypeCode value is HTTPS.Options: Y (enabled)|N (disabled) | |
| loadBalancerRuleList.N.serverProtocolTypeCode | No | String | - Server protocol type code It can be set only when the loadBalancerRuleList.N.protocolTypeCode value is HTTPS.Options : HTTP HTTPSDefault : HTTP | |
| zoneNoList | No | List | Enter when you'd like to change the load balancer's zone. You can obtain the zone number through the getZoneList action. The load balancer IP will change when the zone changes. Zones can't be changed for private IP load balancers. Multi-zone feature support is planned. |
Response
Response body
Examples
Request examples
GET {LOADBALANCER_API_URL}/loadbalancer/v2/changeLoadBalancerInstanceConfiguration?loadBalancerInstanceNo=1083198&loadBalancerAlgorithmTypeCode=RR&loadBalancerRuleList.1.l7HealthCheckPath=/monitor/l7check.html&loadBalancerRuleList.1.loadBalancerPort=88&loadBalancerRuleList.1.serverPort=88&loadBalancerRuleList.1.protocolTypeCode=HTTP
Response examples
<changeLoadBalancerInstanceConfigurationResponse>
<requestId>dbd758a4-8876-420d-8873-010bb78e9f0e</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<loadBalancerInstanceList>
<loadBalancerInstance>
<loadBalancerInstanceNo>1083198</loadBalancerInstanceNo>
<virtualIp>49.236.150.49,49.236.151.137</virtualIp>
<loadBalancerName>loadb1674dfbe5f4</loadBalancerName>
<zoneList>
<zone>
<zoneNo>2</zoneNo>
<zoneName>KR-1</zoneName>
<zoneCode>KR-1</zoneCode>
<zoneDescription>Gasan zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
<zone>
<zoneNo>3</zoneNo>
<zoneName>KR-2</zoneName>
<zoneCode>KR-2</zoneCode>
<zoneDescription>Pyeongchon zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
</zoneList>
<region>
<regionNo>1</regionNo>
<regionCode>KR</regionCode>
<regionName>Korea</regionName>
</region>
<loadBalancerAlgorithmType>
<code>RR</code>
<codeName>Round Robin</codeName>
</loadBalancerAlgorithmType>
<loadBalancerDescription></loadBalancerDescription>
<createDate>2018-11-26T12:06:53+0900</createDate>
<domainName>slb-1083198.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>
<loadBalancerRule>
<protocolType>
<code>HTTP</code>
<codeName>http</codeName>
</protocolType>
<loadBalancerPort>88</loadBalancerPort>
<serverPort>88</serverPort>
<l7HealthCheckPath>/monitor/l7check.html</l7HealthCheckPath>
<certificateName></certificateName>
<proxyProtocolUseYn>N</proxyProtocolUseYn>
<stickySessionUseYn>N</stickySessionUseYn>
<http2UseYn>N</http2UseYn>
</loadBalancerRule>
</loadBalancerRuleList>
<loadBalancedServerInstanceList/>
</loadBalancerInstance>
</loadBalancerInstanceList>
</changeLoadBalancerInstanceConfigurationResponse>
Error codes
Errors that may occur while using this action are listed below. For more information about common errors, please refer to NAVER Cloud Platform API.
| HTTP Response Code | Return code | Return message |
|---|---|---|
| 400 | 23011 | We are sorry that {0} cannot be used for load balancer ports since the ports are in use for load balancer management. |
| 400 | 24063 | The number of load balancer settings has been exceeded. |
| 400 | 24064 | The range of usable {0} port is from 1 to 66534. |
| 400 | 24065 | {0} Duplicated port number. Port number : {1} |
| 400 | 24066 | When setting load balancer, Health Check route must be configured to HTTP protocol. |
| 400 | 24099 | When setting load balancer, Health Check route must be configured to HTTP or HTTPS protocol. |
| 400 | 24109 | The input parameter instance number is invalid |
| 400 | 24111 | The input parameter zone number is invalid. |
| 400 | 24123 | The input parameter load balancer instance number is invalid. |
| 400 | 24130 | The input parameter load balancing algorithm is invalid. |
| 400 | 24131 | The field {0} in the load balancer rule parameter is invalid. |
| 400 | 24132 | The field healthCheckPath in the load balancer rule parameter is invalid. If the protocol is HTTP, it is required. it must start with slash('/') and contain no blank. |
| 400 | 24133 | The field healthCheckPath in the load balancer rule parameter is invalid. If the protocol is NOT HTTP, it must not be specified. |
| 400 | 24134 | The number of input parameter load balancer rules is the minimum of 1, maximum of 5. |
| 400 | 24174 | Can not change zone for private IP load balancer. |
| 400 | 25027 | You may not change since (other) user is operating the target load balance. |
| 400 | 25050 | (Other)Unable to operate load balancer since use is manipulating the applying server. |
| 400 | 26002 | The issuer certificate of a looked up certificate could not be found. This normally means the list of trusted certificates is not complete. |
| 400 | 26003 | The CRL of a certificate could not be found. |
| 400 | 26004 | The certificate signature could not be decrypted. This means that the actual signature value could not be determined rather than it not matching the expected value, this is only meaningful for RSA keys. |
| 400 | 26005 | The CRL signature could not be decrypted: this means that the actual signature value could not be determined rather than it not matching the expected value. Unused. |
| 400 | 26006 | The public key in the certificate SubjectPublicKeyInfo could not be read. |
| 400 | 26007 | The signature of the certificate is invalid. |
| 400 | 26008 | The signature of the certificate is invalid. |
| 400 | 26009 | The certificate is not yet valid: the notBefore date is after the current time. |
| 400 | 26010 | The certificate has expired: that is the notAfter date is before the current time. |
| 400 | 26011 | The CRL is not yet valid. |
| 400 | 26012 | The CRL has expired. |
| 400 | 26013 | The certificate notBefore field contains an invalid time. |
| 400 | 26014 | The certificate notAfter field contains an invalid time. |
| 400 | 26015 | The CRL lastUpdate field contains an invalid time. |
| 400 | 26016 | The CRL nextUpdate field contains an invalid time. |
| 400 | 26017 | An error occurred trying to allocate memory. This should never happen. |
| 400 | 26018 | The passed certificate is self signed and the same certificate cannot be found in the list of trusted certificates. |
| 400 | 26019 | The certificate chain could be built up using the untrusted certificates but the root could not be found locally. |
| 400 | 26020 | The issuer certificate could not be found: this occurs if the issuer certificate of an untrusted certificate cannot be found. |
| 400 | 26021 | No signatures could be verified because the chain contains only one certificate and it is not self signed. |
| 400 | 26022 | The certificate chain length is greater than the supplied maximum depth. Unused. |
| 400 | 26023 | The certificate has been revoked. |
| 400 | 26024 | A CA certificate is invalid. Either it is not a CA or its extensions are not consistent with the supplied purpose. |
| 400 | 26025 | The basicConstraints pathlength parameter has been exceeded. |
| 400 | 26026 | The supplied certificate cannot be used for the specified purpose. |
| 400 | 26027 | The root CA is not marked as trusted for the specified purpose. |
| 400 | 26028 | The root CA is marked to reject the specified purpose. |
| 400 | 26029 | The current candidate issuer certificate was rejected because its subject name did not match the issuer name of the current certificate. Only displayed when the -issuer_checks option is set. |
| 400 | 26030 | The current candidate issuer certificate was rejected because its subject key identifier was present and did not match the authority key identifier current certificate. Only displayed when the -issuer_checks option is set. |
| 400 | 26031 | The current candidate issuer certificate was rejected because its issuer name and serial number was present and did not match the authority key identifier of the current certificate. Only displayed when the -issuer_checks option is set. |
| 400 | 26032 | The current candidate issuer certificate was rejected because its keyUsage extension does not permit certificate signing. |
| 400 | 26033 | An application specific error. Unused. |
| 400 | 26034 | An error occurred during certificate verification. |
| 400 | 26035 | Not found memberNo OR certificateName. Please check your input parameter. |
| 400 | 26036 | Not found memberNo OR certificateName OR privateKey OR publicKeyCertificate. Please check your input parameter. |
| 400 | 26037 | Certificate is being used in another loadBalancer. |
| 400 | 26038 | The certificate name required for SSL/HTTPS. Please check your input parameter. |
| 400 | 26042 | Proxy protocol can be set only with TCP, SSL protocols. |
Was this article helpful?