setLoadBalancerInstanceSubnet

Available in VPC

Set a subnet for a load balancer. It configures subnets including the subnets already set. You can add subnets in different zones from the existing subnets.

Request

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

Method	URI
GET	/vloadbalancer/v2/setLoadBalancerInstanceSubnet

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 subnet settings you want to change First Region of the getRegionList query result (default) See getRegionList.
`loadBalancerInstanceNo`	String	Required	Load balancer instance number See getLoadBalancerInstanceList
`subnetNoList.N`	List[String]	Required	Subnet's number list `subnetNoList` or `loadBalancerSubnetList` must be entered. `loadBalancerSubnetList` is applied if both are passed. Select a subnet located in the selected VPC. One load balancer-only subnet can be selected for each zone, including subnets already configured. Check `subnetNo` through getSubnetList. Example: subnetNoList.1=1234&subnetNoList.2=2345
`loadBalancerSubnetList.N.subnetNo`	String	Conditional	Subnet number `subnetNoList` or `loadBalancerSubnetList` must be entered. `loadBalancerSubnetList` is applied if both are passed. When applying `loadBalancerSubnetList`, `loadBalancerSubnetList.N.subnetNo` is required. Select a subnet located in the same VPC as the load balancer. One load balancer-only subnet can be selected for each zone. Check `subnetNo` through getSubnetList.
`loadBalancerSubnetList.N.publicIpInstanceNo`	String	Optional	Public IP instance number Create and assign a new public IP (default). It can be set if the load balancer's network type is `PUBLIC`.
`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/setLoadBalancerInstanceSubnet?regionCode=KR&loadBalancerInstanceNo=********&subnetNoList.1=******&subnetNoList.2=******' \
--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>32f4e6b9-6790-4c5b-83de-a84157bd6cd7</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>
                <subnetNo>******</subnetNo>
            </subnetNoList>
            <loadBalancerSubnetList>
                <loadBalancerSubnet>
                    <zoneCode>KR-1</zoneCode>
                    <subnetNo>******</subnetNo>
                    <publicIpInstanceNo></publicIpInstanceNo>
                </loadBalancerSubnet>
                <loadBalancerSubnet>
                    <zoneCode>KR-2</zoneCode>
                    <subnetNo>******</subnetNo>
                    <publicIpInstanceNo></publicIpInstanceNo>
                </loadBalancerSubnet>
            </loadBalancerSubnetList>
            <loadBalancerListenerNoList>
                <loadBalancerListenerNo>******</loadBalancerListenerNo>
            </loadBalancerListenerNoList>
        </loadBalancerInstance>
    </loadBalancerInstanceList>
</changeLoadBalancerInstanceConfigurationResponse>