createLoadBalancerInstance
    • PDF

    createLoadBalancerInstance

    • PDF

    Article summary

    Available in Classic

    Create a load balancer instance.

    Request

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

    MethodURI
    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.

    FieldTypeRequiredDescription
    loadBalancerNameStringOptionalName of the load balancer to create
    • Granted automatically by NAVER Cloud Platform (default)
    • 3 to 30 characters
    loadBalancerAlgorithmTypeCodeStringOptionalType of algorithm to use for load balancing
    • RR (default) | SIPHS | LC
      • RR: Round Robin
      • SIPHS: Source IP Hash
      • LC: Least Connection
    loadBalancerDescriptionStringOptionalLoad balancer description (byte)
    • 0 - 1000
    networkUsageTypeCodeStringOptionalNetwork type of the load balancer
    • PBLIP (default) | PRVT
      • PBLIP (Public): public IP
      • PRVT (Private): private IP
    serverInstanceNoList.NStringOptionalList of server instance numbers to bind to the load balancer
    loadBalancerRuleList.N.protocolTypeCodeStringRequiredProtocol type of the load balancer rule
    • HTTP | HTTPS | TCP | SSL
    loadBalancerRuleList.N.loadBalancerPortIntegerRequiredPort 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.serverPortIntegerRequiredServer port of the load balancer rule
    • 1~65534
    • Ports can be duplicated on the same load balancer
    loadBalancerRuleList.N.l7HealthCheckPathStringConditionalHealth check path of the load balancer rule
    • / (default)
    • URL path that starts with /
    • Required if loadBalancerRuleList.N.protocolTypeCode is HTTP or HTTPS
    loadBalancerRuleList.N.certificateNameStringConditionalLoad balancer's SSL certificate name
    Entry is required if loadBalancerRuleList.N.protocloTypeCode is SSL or HTTPS
    loadBalancerRuleList.N.proxyProtocolUseYnStringOptionalWhether to use proxy protocol
    • Y | N
      • Y: enable
      • N: disable
    • It can be enabled if loadBalancerRuleList.N.protocloTypeCode is TCP or SSL
    loadBalancerRuleList.N.stickySessionUseYnStringOptionalWhether 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.http2UseYnStringOptionalWhether to use HTTP/2 protocol
    • Y | N
      • Y: enable
      • N: disable
    • It can be enabled if loadBalancerRuleList.N.protocloTypeCode is HTTPS
    loadBalancerRuleList.N.serverProtocolTypeCodeStringOptionalServer's protocol type
    • HTTP (default) | HTTPS
    • It can be set if loadBalancerRuleList.N.protocloTypeCode is HTTPS=
    regionNoStringOptionalNumber of the Region in which you want to create the load balancer
  • Check through getRegionList
  • Randomly assigned to a zone in the Korea Region if neither Region nor Zone is entered
  • zoneNoListList<String>OptionalList 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 response status codes common to NAVER Cloud Platform, see Ncloud API 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>
    

    Response status codes

    The following describes the response status codes.

    HTTP status codeCodeMessageDescription
    40010300Instance name is already in use. please use other nameInstance name can't be duplicated
    40010105Unable to create load balancer anymore since contract limitation setting has been exceeded. Number of contract limitation: {0} Number of current contracts: {1}Service usage limit exceeded
    40023011We are sorry that {0} cannot be used for load balancer ports since the ports are in use for load balancer managementThe port already in use for load balancer management
    40023017This version of the load balancer can not create with private IPLoad balancer that can't be created with private IP addresses
    40023018Can not create the load balancerLoad balancer creation error
    40023019There is no resource for the load balancerNo resources on the load balancer
    40024063The number of load balancer settings has been exceededLoad balancer setting limits exceeded
    40024064The range of usable {0} port is from 1 to 66534The port number must be between 1 and 66534
    40024065{0} Duplicated port number. Port number : {1}Port numbers can't be duplicated
    40024066When setting load balancer, Health Check route must be configured to HTTP protocolRequired to enter a health check path if the protocol type of the load balancer rule is HTTP
    40024091No IP address is assigned to the server instance (no. {0}).No IP address assigned to the server instance
    40024099When setting load balancer, Health Check route must be configured to HTTP or HTTPS protocolRequired to enter a health check path if the protocol type of the load balancer rule is HTTP or HTTPS
    40024109The input parameter instance number is invalidInvalid instance number
    40024111The input parameter zone number is invalidInvalid zone number
    40024120The input parameter server instance number is invalidInvalid server instance number
    40024130The input parameter load balancing algorithm is invalid.Invalid load balancing algorithm
    40024131The field {0} in the load balancer rule parameter is invalidThe {0} field in the load balancer rule is invalid
    40024132The field healthCheckPath in the load balancer rule parameter is invalid. If the protocol is HTTP, it is required. it must start with slash ("/") and contain no blank Health check path required if the protocol type of the load balancer rule is HTTP. The URL path must start with "/" and contain no spaces
    40024133The field healthCheckPath in the load balancer rule parameter is invalid. If the protocol is NOT HTTP, it must not be specifiedHealth check path can't be specified unless the protocol type of the load balancer rule is HTTP
    40024134The number of input parameter load balancer rules is the minimum of 1, maximum of 5Character length limit: 1 to 5
    40024173Only one zone can be selected for private IP load balancerOnly one zone can be entered for load balancers with private IP addresses
    40024300The length constraints of the parameter description (memo) were violated. The minimum length is 0 byte, the maximum, 1000 bytesDescription must be between 1 and 1000 bytes
    40025050(Other)Unable to operate load balancer since use is manipulating the applying server.Unavailable because the server is being applied to a load balancer
    40025051Server is already being applied to load balancerThe server is already applied by the load balancer
    40025052Server {0} is unable to apply to load balancer since it is either in operation or not being suspendedThe server is running or not stopped and therefore not applicable to the load balancer
    40026034An error occurred during certificate verificationCertificate verification error
    40026035Not found memberNo OR certificateName. Please check your input parameterUnable to find the member ID or the certificate name
    40026036Not found memberNo OR certificateName OR privateKey OR publicKeyCertificate. Please check your input parameterUnable to find member ID, certificate name, secret key, or public key
    40026037Certificate is being used in another loadBalancerCertificate already in use by another load balancer
    40026002The issuer certificate of a looked up certificate could not be found. This normally means the list of trusted certificates is not completeUnable to find the certificate issuer
    40026003The CRL of a certificate could not be foundUnable to find the CRL
    40026004The certificate signature could not be decrypted. This means that the actual signature value could not be determined rather than it not matching the expected value, this is only meaningful for RSA keysCertificate signature decryption failed
    40026005The CRL signature could not be decrypted: this means that the actual signature value could not be determined rather than it not matching the expected value. UnusedCRL signature decryption failed
    40026006The public key in the certificate SubjectPublicKeyInfo could not be readUnable to read the certificate public key
    40026007The signature of the certificate is invalidInvalid certificate signature
    40026008The signature of the certificate is invalidInvalid certificate signature
    40026009The certificate is not yet valid: the notBefore date is after the current timeCertificate validity start date is set beyond the current date
    40026010The certificate has expired: that is the notAfter date is before the current timeCertificate validity expiration date is set before the current date
    40026011The CRL is not yet validInvalid CRL
    40026012The CRL has expiredExpired CRL
    40026013The certificate notBefore field contains an invalid timeInvalid certificate validity start date and time
    40026014The certificate notAfter field contains an invalid timeInvalid certificate validity expiration date and time
    40026015The CRL lastUpdate field contains an invalid timeCRL's last update date and time is invalid
    40026016The CRL nextUpdate field contains an invalid timeCRL's next update date and time is invalid
    40026017An error occurred trying to allocate memory. This should never happenMemory allocation error
    40026018The passed certificate is self signed and the same certificate cannot be found in the list of trusted certificatesSelf-signed certificate not found in the list of trusted certificates
    40026019The certificate chain could be built up using the untrusted certificates but the root could not be found locallyRoot certificate not found on local computer
    40026020The issuer certificate could not be found: this occurs if the issuer certificate of an untrusted certificate cannot be foundUnable to find the certificate issuer
    40026021No signatures could be verified because the chain contains only one certificate and it is not self signedSignature authentication failed
    40026022The certificate chain length is greater than the supplied maximum depth. UnusedCertificate chain length limit exceeded
    40026023The certificate has been revokedCertificate revoked
    40026024A CA certificate is invalid. Either it is not a CA or its extensions are not consistent with the supplied purposeInvalid CA certificate
    40026025The basicConstraints path length parameter has been exceededAuthentication path length limit exceeded
    40026026The supplied certificate cannot be used for the specified purposeCertificate not available for this purpose
    40026027The root CA is not marked as trusted for the specified purposeRoot CA certificate not trusted
    40026028The root CA is marked to reject the specified purposeRoot CA certificate request denied
    40026029The current candidate issuer certificate was rejected because its subject name did not match the issuer name of the current certificate. Only displayed when the -issuer_checks option is setCertificate request rejected because subject does not match issuer
    40026030The current candidate issuer certificate was rejected because its subject key identifier was present and did not match the authority key identifier current certificate. Only displayed when the -issuer_checks option is setCertificate request rejected because subject key identifier does not match authority key identifier
    40026031The current candidate issuer certificate was rejected because its issuer name and serial number was present and did not match the authority key identifier of the current certificate. Only displayed when the -issuer_checks option is setCertificate request rejected because the certificate issuer and serial number do not match the authority key identifier
    40026032The current candidate issuer certificate was rejected because its keyUsage extension does not permit certificate signingCertificate request rejected because key purpose extension does not allow signing
    40026033An application specific error. UnusedApplication error
    40026034An error occurred during certificate verificationCertificate verification error
    40026035Not found memberNo OR certificateName. Please check your input parameterUnable to find the member ID or the certificate name
    40026036Not found memberNo OR certificateName OR privateKey OR publicKeyCertificate. Please check your input parameterUnable to find member ID, certificate name, secret key, or public key
    40026037Certificate is being used in another loadBalancerCertificate already in use by another load balancer
    40026038The certificate name required for SSL/HTTPS. Please check your input parameterCertificate name required if the protocol type of the load balancer rule is SSL or HTTPS
    40026042Proxy protocol can be set only with TCP, SSL protocolsProxy protocol can only be set if the protocol type of the load balancer rule is TCP or SSL

    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.