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.

changeLoadBalancedServerInstances

Prev Next

Available in Classic

Change the server instance bound to a load balancer. Previously bound information is reset and bound anew.

Request

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

Method URI
GET /loadbalancer/v2/changeLoadBalancedServerInstances

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 for which you want to change the bound setting
serverInstanceNoList.N List[String] Required List of server instance numbers to bind to the load balancer
  • <E.g.> serverInstanceNoList.1=123&serverInstanceNoList.2=124

Request example

The following is a sample request.

curl --location 'https://ncloud.apigw.ntruss.com/loadbalancer/v2/changeLoadBalancedServerInstances?loadBalancerInstanceNo=*******&serverInstanceNoList.1=*******' \
--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.

<changeLoadBalancedServerInstancesResponse>
    <requestId>d6e80b53-658a-4adc-9683-83be3675d508</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-07T19:28:24+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>
            </zoneList>
            <loadBalancerRuleList>
                <loadBalancerRule>
                    <protocolType>
                        <code>HTTP</code>
                        <codeName>http</codeName>
                    </protocolType>
                    <loadBalancerPort>80</loadBalancerPort>
                    <serverPort>80</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:59+0900</createDate>
                        <uptime>2024-06-07T18:34:46+0900</uptime>
                        <serverImageProductCode>SPSW0LINUX000130</serverImageProductCode>
                        <serverProductCode>SPSVRSSD00000003</serverProductCode>
                        <isProtectServerTermination>false</isProtectServerTermination>
                        <portForwardingPublicIp>***.**.**.**</portForwardingPublicIp>
                        <zone>
                            <zoneNo>3</zoneNo>
                            <zoneName>KR-2</zoneName>
                            <zoneCode>KR-2</zoneCode>
                            <zoneDescription>Pyeongchon 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>80</loadBalancerPort>
                            <serverPort>80</serverPort>
                            <l7HealthCheckPath>/</l7HealthCheckPath>
                            <proxyProtocolUseYn>N</proxyProtocolUseYn>
                            <serverStatus>false</serverStatus>
                        </serverHealthCheckStatus>
                    </serverHealthCheckStatusList>
                </loadBalancedServerInstance>
            </loadBalancedServerInstanceList>
        </loadBalancerInstance>
    </loadBalancerInstanceList>
</changeLoadBalancedServerInstancesResponse>