changeLoadBalancerInstanceConfiguration

Prev Next

Available in VPC

Change load balancer instance settings.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /vloadbalancer/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
regionCode String Optional Region code of the load balancer instance whose settings you want to change
  • First Region of the getRegionList query result (default)
  • See getRegionList
loadBalancerInstanceNo String Required Load balancer instance number
throughputTypeCode String Conditional Load handling performance type
  • SMALL (default) | MEDIUM | LARGE | DYNAMIC| XLARGE
  • The values that can be selected are limited depending on the type of load balancer
    • Application, Network Proxy Load Balancer: SMALL (default) | MEDIUM | LARGE| XLARGE
    • Network Load Balancer: DYNAMIC (default)
idleTimeout Integer Conditional Connection retention time (second)
  • 1 - 3600 (default: 60)
  • Can't be configured if the load balancer type is NETWORK
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The request example is as follows:

curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/changeLoadBalancerInstanceConfiguration?regionCode=KR&loadBalancerInstanceNo=********&throughputTypeCode=SMALL&idleTimeout=60' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

See LoadBalancerInstanceList 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 response example is as follows:

<changeLoadBalancerInstanceConfigurationResponse>
    <requestId>2b183b0f-b67f-433f-9660-58f23a590c69</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <loadBalancerInstanceList>
        <loadBalancerInstance>
            <loadBalancerInstanceNo>********</loadBalancerInstanceNo>
            <loadBalancerInstanceStatus>
                <code>USED</code>
                <codeName>LB USED state</codeName>
            </loadBalancerInstanceStatus>
            <loadBalancerInstanceOperation>
                <code>CHANG</code>
                <codeName>LB CHANGE OP</codeName>
            </loadBalancerInstanceOperation>
            <loadBalancerInstanceStatusName>Changing</loadBalancerInstanceStatusName>
            <loadBalancerDescription></loadBalancerDescription>
            <createDate>2024-06-03T17:09:52+0900</createDate>
            <loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
            <loadBalancerDomain>***.com</loadBalancerDomain>
            <loadBalancerIpList>
                <loadBalancerIp>**.*.*.*</loadBalancerIp>
            </loadBalancerIpList>
            <loadBalancerType>
                <code>APPLICATION</code>
                <codeName>Application Load Balancer</codeName>
            </loadBalancerType>
            <loadBalancerNetworkType>
                <code>PRIVATE</code>
                <codeName>Private</codeName>
            </loadBalancerNetworkType>
            <throughputType>
                <code>SMALL</code>
                <codeName>Small</codeName>
            </throughputType>
            <idleTimeout>60</idleTimeout>
            <vpcNo>*****</vpcNo>
            <regionCode>KR</regionCode>
            <subnetNoList>
                <subnetNo>******</subnetNo>
            </subnetNoList>
            <loadBalancerSubnetList>
                <loadBalancerSubnet>
                    <zoneCode>KR-1</zoneCode>
                    <subnetNo>******</subnetNo>
                    <publicIpInstanceNo></publicIpInstanceNo>
                </loadBalancerSubnet>
            </loadBalancerSubnetList>
            <loadBalancerListenerNoList>
                <loadBalancerListenerNo>******</loadBalancerListenerNo>
            </loadBalancerListenerNoList>
        </loadBalancerInstance>
    </loadBalancerInstanceList>
</changeLoadBalancerInstanceConfigurationResponse>