createLoadBalancerInstance

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Create a load balancer instance.

Request

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

Method	URI
GET	/createLoadBalancerInstance

Request headers

For headers common to all Load Balancer APIs, see Load Balancer common headers.

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code for the load balancer instance you want to create First Region of the getRegionList search result (default) Check through getRegionList
`loadBalancerTypeCode`	String	Required	Load balancer type `APPLICATION` \| `NETWORK` \| `NETWORK_PROXY`
`loadBalancerName`	String	Optional	Name of the load balancer Automatically granted by NAVER Cloud Platform (default) 3 to 30 characters, including English letters, numbers, and the special character "-", and must begin with an English letter and end with an English letter or number
`loadBalancerNetworkTypeCode`	String	Optional	Load balancer network type `PUBLIC` (default) \| `PRIVATE`
`throughputTypeCode`	String	Optional	Load balancing performance type `SMALL` \| `MEDIUM` \| `LARGE` \| `DYNAMIC` Type of load balancer limits the values you can select Application, Network Proxy Load Balancer: `SMALL` (default) \| `MEDIUM` \| `LARGE` Network Load Balancer: `DYNAMIC` (default)
`idleTimeout`	Integer	Optional	Connection retention time (seconds) 1 - 3600 (default: 60) Unable to set if load balancer's type is `NETWORK`
`vpcNo`	String	Required	VPC number of the load balancer to create Check through getVpcList
`loadBalancerDescription`	String	Optional	Load balancer description (byte) 0 - 1000
`subnetNoList.N`	List<String>	Conditional	Subnet number list `subnetNoList` or `loadBalancerSubnetList` must be entered `loadBalancerSubnetList` is applied when both are passed Select a subnet located in the selected VPC One dedicated load balancer subnet can be selected per zone `subnetNo` can be obtained through getSubnetList <E.g.> subnetNoList.1=1234&subnetNoList.2=2345
`loadBalancerSubnetList.N.subnetNo`	String	Conditional	Subnet number `subnetNoList` or `loadBalancerSubnetList` must be entered `loadBalancerSubnetList` is applied when both are passed `loadBalancerSubnetList.N.subnetNo` is required when applying `loadBalancerSubnetList` Select a subnet located in the selected VPC One dedicated load balancer subnet can be selected per zone `subnetNo` can be obtained 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` It is only available in Singapore and Japan Regions
`loadBalancerListenerList.protocolTypeCode`	String	Required	Protocol type of load balancer listener `HTTP` \| `HTTPS` \| `TCP` \| `UDP` \| `TLS` Type of load balancer limits the values you can select Application Load Balancer: `HTTP` (default) \| `HTTPS` Network Load Balancer: `TCP` (default) \| `UDP` Network Proxy Load Balancer: `TCP` (default) \| `TLS` `UDP` protocol is only available in Singapore and Japan Regions
`loadBalancerListenerList.N.port`	Integer	Optional	Load balancer listener's port 1 - 65534 The default port value is decided depending on the listener protocol type `HTTP`, `TCP`, `UDP` protocol: 80 `HTTPS`, `TLS` protocol: 443 It can't be duplicated with an existing registered listener port
`loadBalancerListenerList.N.targetGroupNo`	String	Required	Target group number applied to each listener's default rule `targetGroupNo` can be obtained through getTargetGroupList Available target groups are limited by the type of load balancer and the protocol type of the target group Application Load Balancer: `HTTP` \| `HTTPS` Network Load Balancer: `TCP` \| `UDP` Network Proxy Load Balancer: `PROXY_TCP` Target groups already in use by another load balancer can't be used
`loadBalancerListenerList.N.useHttp2`	Boolean	Optional	Whether to use the HTTP/2 protocol `true` \| `false` (default) It can be set if the listener's protocol type is `HTTPS`
`loadBalancerListenerList.N.sslCertificateNo`	String	Conditional	SSL certificate number `sslCertificateNo` can be obtained through getCertificateList If the listener's protocol type is `HTTPS` or `TLS`, the SSL certificate must be set
`loadBalancerListenerList.N.tlsMinVersionTypeCode`	String	Optional	TLS minimum supported version `TLSV10` (default) \| `TLSV11` \| `TLSV12` `TLSV10`: TLS 1.0 `TLSV11`: TLS 1.1 `TLSV12`: TLS 1.2 It can be set if the listener's protocol type is `HTTPS` or `TLS`
`loadBalancerListenerList.N.cipherSuiteList.N`	List<String>	Optional	List of encryption tools provided by the load balancer when negotiating encryption with the client `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA` \| `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256` \| `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256` \| `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA` \| `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384` \| `TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384` \| `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` \| `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` \| `TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` \| `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA` \| `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384` \| `TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384` \| `TLS_RSA_WITH_AES_128_CBC_SHA` \| `TLS_RSA_WITH_AES_128_CBC_SHA256` \| `TLS_RSA_WITH_AES_128_GCM_SHA256` \| `TLS_RSA_WITH_AES_256_CBC_SHA` \| `TLS_RSA_WITH_AES_256_CBC_SHA256` \| `TLS_RSA_WITH_AES_256_GCM_SHA384` \| `TLS_DHE_RSA_WITH_AES_128_CBC_SHA` \| `TLS_DHE_RSA_WITH_AES_128_CBC_SHA256` \| `TLS_DHE_RSA_WITH_AES_256_CBC_SHA` \| `TLS_DHE_RSA_WITH_AES_256_CBC_SHA256` Select All (default) It can be set if the listener's protocol type is `HTTPS` or `TLS`
`responseFormatType`	String	Optional	Response result format `xml` (default) \| `json`

Request example

The following is a sample request.

curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/createLoadBalancerInstance
?regionCode=KR
&loadBalancerTypeCode=APPLICATION
&loadBalancerName=YOUR_LOAD_BALANCER
&loadBalancerNetworkTypeCode=PRIVATE
&throughputTypeCode=SMALL
&idleTimeout=60
&vpcNo=*****
&subnetNoList.1=******
&loadBalancerListenerList.1.protocolTypeCode=HTTP
&loadBalancerListenerList.1.port=80
&loadBalancerListenerList.1.targetGroupNo=*******'
--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 LoadBalancerInstanceList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

<createLoadBalancerInstanceResponse>
    <requestId>48df95ef-b0bc-4338-bbc8-7126965c0987</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <loadBalancerInstanceList>
        <loadBalancerInstance>
            <loadBalancerInstanceNo>********</loadBalancerInstanceNo>
            <loadBalancerInstanceStatus>
                <code>INIT</code>
                <codeName>LB INIT state</codeName>
            </loadBalancerInstanceStatus>
            <loadBalancerInstanceOperation>
                <code>CREAT</code>
                <codeName>LB CREATE OP</codeName>
            </loadBalancerInstanceOperation>
            <loadBalancerInstanceStatusName>Creating</loadBalancerInstanceStatusName>
            <loadBalancerDescription></loadBalancerDescription>
            <createDate>2024-06-03T18:52:28+0900</createDate>
            <loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
            <loadBalancerDomain>***.com</loadBalancerDomain>
            <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>
</createLoadBalancerInstanceResponse>

Was this article helpful?

What's Next

changeLoadBalancerInstanceConfiguration

Table of contents

Request
Response