MENU
      createLoadBalancerInstance

        createLoadBalancerInstance


        Article summary

        Available in VPC

        Create a load balancer instance.

        Request

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

        MethodURI
        GET/createLoadBalancerInstance

        Request headers

        For information about the headers common to all Load Balancer APIs, see Common Load Balancer headers.

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        regionCodeStringOptionalRegion code of the load balancer instance you want to create
        • First Region of the getRegionList query result (default)
        • Check through getRegionList
        loadBalancerTypeCodeStringRequiredLoad balancer type
        • APPLICATION | NETWORK | NETWORK_PROXY
        loadBalancerNameStringOptionalLoad balancer name
        • Granted automatically by NAVER Cloud Platform (default)
        • 3 to 30 characters, including letters, numbers, and the special character "-", and must begin with an English letter and end with an English letter or number
        loadBalancerNetworkTypeCodeStringOptionalLoad balancer's network type
        • PUBLIC (default) | PRIVATE
        throughputTypeCodeStringOptionalLoad 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)
        idleTimeoutIntegerOptionalConnection retention time (second)
        • 1 - 3600 (default: 60)
        • Can't be configured if the load balancer type is NETWORK
        vpcNoStringRequiredVPC number of the load balancer you want to create
        loadBalancerDescriptionStringOptionalDescription of the load balancer (byte)
        • 0 - 1,000
        subnetNoList.NList<String>ConditionalSubnet'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
        • Check subnetNo through getSubnetList
        • <e.g.> subnetNoList.1=1234&subnetNoList.2=2345
        loadBalancerSubnetList.N.subnetNoStringConditionalSubnet 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 selected VPC
        • One load balancer-only subnet can be selected for each zone
        • Check subnetNo through getSubnetList
        loadBalancerSubnetList.N.publicIpInstanceNoStringOptionalPublic 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.N.protocolTypeCodeStringOptionalProtocol 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.portIntegerOptionalPort of the load balancer listener
        • 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.targetGroupNoStringRequiredTarget 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.useHttp2BooleanOptionalWhether to use HTTP/2 protocol
        • true | false (default)
        • It can be set if the listener's protocol type is HTTPS
        loadBalancerListenerList.N.sslCertificateNoStringConditionalSSL 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.tlsMinVersionTypeCodeStringOptionalTLS 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.NList<String>OptionalList 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
        responseFormatTypeStringOptionalFormat of the response result
        • xml (default) | json

        Request example

        The request example is as follows:

        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}'
        Curl

        Response

        This section 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 response example is as follows:

        <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>
        XML

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.