createLoadBalancerInstance

Available in Classic

Create a load balancer instance.

Request

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

Method	URI
GET	/loadbalancer/v2/createLoadBalancerInstance

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
`loadBalancerName`	String	Optional	Name of the load balancer to create Granted automatically by NAVER Cloud Platform (default) 3 to 30 characters
`loadBalancerAlgorithmTypeCode`	String	Optional	Type of algorithm to use for load balancing `RR` (default) \| `SIPHS` \| `LC` `RR`: Round Robin `SIPHS`: Source IP Hash `LC`: Least Connection
`loadBalancerDescription`	String	Optional	Load balancer description (byte) 0 - 1000
`networkUsageTypeCode`	String	Optional	Network type of the load balancer `PBLIP` (default) \| `PRVT` `PBLIP` (Public): public IP `PRVT` (Private): private IP
`serverInstanceNoList.N`	String	Optional	List of server instance numbers to bind to the load balancer See getLoadBalancancerTargetServerInstanceList
`loadBalancerRuleList.N.protocolTypeCode`	String	Required	Protocol type of the load balancer rule `HTTP` \| `HTTPS` \| `TCP` \| `SSL`
`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 Entry is 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`=
`regionNo`	String	Optional	Number of the Region in which you want to create the load balancer See getRegionList Randomly assigned to a zone in the Korea Region if neither Region nor Zone is entered
`zoneNoList`	List[String]	Optional	List of zone numbers for which you want to create the load balancer Check `zoneNo` through getRegionList Private IP load balancers can only select 1 zone, 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/createLoadBalancerInstance?loadBalancerRuleList.1.l7HealthCheckPath=/&loadBalancerRuleList.1.loadBalancerPort=80&loadBalancerRuleList.1.protocolTypeCode=HTTP&loadBalancerRuleList.1.serverPort=80' \
--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.

<createLoadBalancerInstanceResponse>
    <requestId>1e3eac26-c57e-4c8b-b6b0-ba3fe2330a61</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>slb-24784632.ncloudslb.com</domainName>
            <loadBalancerInstanceStatusName>creating</loadBalancerInstanceStatusName>
            <loadBalancerInstanceStatus>
                <code>INIT</code>
                <codeName>NET INIT state</codeName>
            </loadBalancerInstanceStatus>
            <loadBalancerInstanceOperation>
                <code>USE</code>
                <codeName>NET USE 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/>
        </loadBalancerInstance>
    </loadBalancerInstanceList>
</createLoadBalancerInstanceResponse>

Documentation Index