Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

changeLoadBalancerInstanceConfiguration

Prev Next

Available in Classic

Change the configuration value of a load balancer instance rule.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /loadbalancer/v2/changeLoadBalancerInstanceConfiguration

Request headers

For information about the headers common to all Load Balancer APIs, see Load Balancer request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
loadBalancerInstanceNo String Required Number of the load balancer instance whose settings you want to change
loadBalancerAlgorithmTypeCode String Required Type of algorithm to use for load balancing
  • RR | LC
    • RR: Round Robin
    • LC: Least Connection
loadBalancerDescription String Optional Load balancer description (byte)
  • 0 - 1000
loadBalancerRuleList.N.protocolTypeCode String Required Protocol type of the load balancer rule
  • HTTP | HTTPS | TCP
loadBalancerRuleList.N.loadBalancerPort Integer Required Port of the load balancer rule
  • 1 - 65534
  • No port duplication on the same load balancer
  • Ports 22, 3389, 64000, 65130, 65131, and 18080 - 18095 are unavailable since they're for load balancer management
loadBalancerRuleList.N.serverPort Integer Required Server port of the load balancer rule
  • 1~65534
  • Ports can be duplicated on the same load balancer
loadBalancerRuleList.N.l7HealthCheckPath String Conditional Health check path of the load balancer rule
  • / (default)
  • URL path that starts with /
  • Required if loadBalancerRuleList.N.protocolTypeCode is HTTP or HTTPS
loadBalancerRuleList.N.certificateName String Conditional Load balancer's SSL certificate name
  • Required if loadBalancerRuleList.N.protocloTypeCode is SSL or HTTPS
loadBalancerRuleList.N.proxyProtocolUseYn String Optional Whether to use proxy protocol
  • Y | N
    • Y: enable
    • N: disable
  • It can be enabled if loadBalancerRuleList.N.protocloTypeCode is TCP or SSL
loadBalancerRuleList.N.stickySessionUseYn String Optional Whether to use per-session access
  • Y | N
    • Y: enable
    • N: disable
  • It can be enabled if loadBalancerRuleList.N.protocloTypeCode is HTTP or HTTPS
loadBalancerRuleList.N.http2UseYn String Optional Whether to use HTTP/2 protocol
  • Y | N
    • Y: enable
    • N: disable
  • It can be enabled if loadBalancerRuleList.N.protocloTypeCode is HTTPS
loadBalancerRuleList.N.serverProtocolTypeCode String Optional Server's protocol type
  • HTTP (default) | HTTPS
  • It can be set if loadBalancerRuleList.N.protocloTypeCode is HTTPS=
zoneNoList List[String] Optional List of zone numbers for which you want to change the zone of the load balancer
  • zoneNo can be checked through getRegionList
  • Changing the zone changes the load balancer IP
  • Zones can't be changed for private IP load balancers, and multi-zone support will be available soon

Request example

The following is a sample request.

curl --location 'https://ncloud.apigw.ntruss.com/loadbalancer/v2/changeLoadBalancerInstanceConfiguration?loadBalancerInstanceNo=*******&loadBalancerAlgorithmTypeCode=RR&loadBalancerRuleList.1.l7HealthCheckPath=/&loadBalancerRuleList.1.loadBalancerPort=88&loadBalancerRuleList.1.serverPort=88&loadBalancerRuleList.1.protocolTypeCode=HTTP' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

See LoadBalancerInstance for the response body.

Response status codes

For information about the HTTP status codes common to all Load Balancer APIs, see Load Balancer response status codes.

Response example

The following is a sample response.

<changeLoadBalancerInstanceConfigurationResponse>
    <requestId>cdb87e60-2bf1-4438-8d55-470c9f17521c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <loadBalancerInstanceList>
        <loadBalancerInstance>
            <loadBalancerInstanceNo>********</loadBalancerInstanceNo>
            <virtualIp>***.**.***.**,**.**.***.***</virtualIp>
            <loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
            <loadBalancerAlgorithmType>
                <code>RR</code>
                <codeName>Round Robin</codeName>
            </loadBalancerAlgorithmType>
            <loadBalancerDescription></loadBalancerDescription>
            <createDate>2024-06-07T18:46:01+0900</createDate>
            <domainName>***.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>
            <region>
                <regionNo>1</regionNo>
                <regionCode>KR</regionCode>
                <regionName>Korea</regionName>
            </region>
            <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>
            <loadBalancerRuleList>
                <loadBalancerRule>
                    <protocolType>
                        <code>HTTP</code>
                        <codeName>http</codeName>
                    </protocolType>
                    <loadBalancerPort>88</loadBalancerPort>
                    <serverPort>88</serverPort>
                    <l7HealthCheckPath>/</l7HealthCheckPath>
                    <certificateName></certificateName>
                    <proxyProtocolUseYn>N</proxyProtocolUseYn>
                    <stickySessionUseYn>N</stickySessionUseYn>
                    <http2UseYn>N</http2UseYn>
                </loadBalancerRule>
            </loadBalancerRuleList>
            <loadBalancedServerInstanceList>
                <loadBalancedServerInstance>
                    <serverInstance>
                        <serverInstanceNo>********</serverInstanceNo>
                        <serverName>YOUR_SERVER</serverName>
                        <serverDescription></serverDescription>
                        <cpuCount>2</cpuCount>
                        <memorySize>4294967296</memorySize>
                        <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                        <platformType>
                            <code>UBS64</code>
                            <codeName>Ubuntu Server 64 Bit</codeName>
                        </platformType>
                        <loginKeyName>YOUR_LOGIN_KEY</loginKeyName>
                        <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                        <publicIp></publicIp>
                        <privateIp>**.**.***.***</privateIp>
                        <serverImageName>ubuntu-18.04</serverImageName>
                        <serverInstanceStatus>
                            <code>RUN</code>
                            <codeName>Server run state</codeName>
                        </serverInstanceStatus>
                        <serverInstanceOperation>
                            <code>NULL</code>
                            <codeName>Server NULL OP</codeName>
                        </serverInstanceOperation>
                        <serverInstanceStatusName>running</serverInstanceStatusName>
                        <createDate>2024-06-07T18:28:41+0900</createDate>
                        <uptime>2024-06-07T18:35:09+0900</uptime>
                        <serverImageProductCode>SPSW0LINUX000130</serverImageProductCode>
                        <serverProductCode>SPSVRSSD00000003</serverProductCode>
                        <isProtectServerTermination>false</isProtectServerTermination>
                        <portForwardingPublicIp>***.***.***.***</portForwardingPublicIp>
                        <zone>
                            <zoneNo>2</zoneNo>
                            <zoneName>KR-1</zoneName>
                            <zoneCode>KR-1</zoneCode>
                            <zoneDescription>Gasan zone</zoneDescription>
                            <regionNo>1</regionNo>
                        </zone>
                        <region>
                            <regionNo>1</regionNo>
                            <regionCode>KR</regionCode>
                            <regionName>Korea</regionName>
                        </region>
                        <baseBlockStorageDiskType>
                            <code>NET</code>
                            <codeName>Network Storage</codeName>
                        </baseBlockStorageDiskType>
                        <baseBlockStorageDiskDetailType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </baseBlockStorageDiskDetailType>
                        <serverInstanceType>
                            <code>STAND</code>
                            <codeName>Standard</codeName>
                        </serverInstanceType>
                        <userData></userData>
                        <initScriptNo></initScriptNo>
                        <accessControlGroupList>
                            <accessControlGroup>
                                <accessControlGroupConfigurationNo>******</accessControlGroupConfigurationNo>
                                <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                                <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                                <isDefault>true</isDefault>
                                <createDate>2021-06-22T18:09:57+0900</createDate>
                            </accessControlGroup>
                        </accessControlGroupList>
                        <instanceTagList/>
                    </serverInstance>
                    <serverHealthCheckStatusList>
                        <serverHealthCheckStatus>
                            <protocolType>
                                <code>HTTP</code>
                                <codeName>http</codeName>
                            </protocolType>
                            <loadBalancerPort>88</loadBalancerPort>
                            <serverPort>88</serverPort>
                            <l7HealthCheckPath>/</l7HealthCheckPath>
                            <proxyProtocolUseYn>N</proxyProtocolUseYn>
                            <serverStatus>false</serverStatus>
                        </serverHealthCheckStatus>
                    </serverHealthCheckStatusList>
                </loadBalancedServerInstance>
            </loadBalancedServerInstanceList>
        </loadBalancerInstance>
    </loadBalancerInstanceList>
</changeLoadBalancerInstanceConfigurationResponse>
Business Registration Number: 129-86-31394 E-commerce Permit Number:No. 2009-GyeonggiSeongnam-0510
CEO: Kim Yuwon Address: NAVER Green Factory 17th–26th Floors, Buljeong-ro 6, Bundang-gu, Seongnam-si, Gyeonggi-do 13561, Republic of Korea. Customer Support Number: 1544-5876
© NAVER Cloud Corp. All Rights Reserved.