Login
      Contents x
      createLoadBalancerInstance
        • Print
        • PDF
        Contents

        createLoadBalancerInstance

          • Print
          • PDF
          Article Summary

          Can be used in a Classic environment.

          Overview

          Create load balancer instances.

          Request

          Request header

          Header nameDescription
          x-ncp-apigw-timestampIt indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds.
          If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
          x-ncp-apigw-api-keyKey issued from API Gateway (no need to enter in the v2 version)
          x-ncp-iam-access-keyAPI key issued by NAVER Cloud Platform or access key issued by IAM
          x-ncp-apigw-signature-v2A signature that encrypts the body with secret key mapped to the access key
          HmacSHA256 is used for HMAC encryption algorithm.

          Request parameter

          Parameter nameRequirement statusTypeRestrictionsDescription
          loadBalancerNameNoStringMin : 3
          Max : 30          		The name of the load balancer to create. Default: automatically assigned by NAVER Cloud Platform
          loadBalancerAlgorithmTypeCodeNoStringMin : 1
          Max : 5          		- Load balancer algorithm type code
          Algorithms that can be entered:
          RR (ROUND ROBIN)
          LC (LEAST_CONNECTION)
          SIPHS (Source IP Hash)
          default : RR (Round Robin)
          loadBalancerDescriptionNoStringMin : 1
          Max : 1000          		Load balancer description
          networkUsageTypeCodeNoStringMin : 1
          Max : 5          		- Network usage type code
          Options to create the load balancer with public or private IP
          PBLIP (public IP load balancer) PRVT (private IP load balancer)
          Default: PBLIP (public IP load balancer)
          serverInstanceNoList.NNoStringNot to be duplicated- Server instance number list to bind to the load balancer
          The server instance numbers can be obtained through the getLoadBalancancerTargetServerInstanceList action.
          loadBalancerRuleList.N.protocolTypeCodeYesStringMin : 1
          Max : 5          		Enter the protocol type code in the load balancer rule.
          The following codes can be used for protocol type code:
          HTTP HTTPS TCP SSL
          loadBalancerRuleList.N.loadBalancerPortYesIntegerMin : 1
          Max : 65534          		It sets load balancer ports in the load balancer rule.
          Load balancer ports in one load balancer must not overlap.
          Ports 22, 3389, 64000, 65130, 65131, and 18080 - 18095 can't be used since they're reserved for load balancer management.
          loadBalancerRuleList.N.serverPortYesIntegerMin : 1
          Max : 65534          		- Server port in the load balancer rule
          Server port overlaps in one load balancer are allowed.
          loadBalancerRuleList.N.l7HealthCheckPathConditionalStringMin : 1
          Max : 600          		- Health check path of the load balancer rule
          Required if the loadBalancerRuleList.N.protocolTypeCode value is HTTP HTTPS.
          loadBalancerRuleList.N.certificateNameConditionalStringMin : 1
          Max : 300          		Enter the load balancer's SSL public certificate name.
          Required if the loadBalancerRuleList.N.protocolTypeCode value is SSL HTTPS.
          loadBalancerRuleList.N.proxyProtocolUseYnNoString- Proxy protocol usage status
          It can be set only when the loadBalancerRuleList.N.protocolTypeCode value is TCP SSL.
          Options: Y (enabled)|N (disabled)
          loadBalancerRuleList.N.stickySessionUseYnNoString- Access by session usage status
          It can be set only when the loadBalancerRuleList.N.protocolTypeCode value is HTTP HTTPS.
          Options: Y (enabled)|N (disabled)
          loadBalancerRuleList.N.http2UseYnNoString- HTTP/2 protocol usage status
          It can be set only when the loadBalancerRuleList.N.protocolTypeCode value is HTTPS.
          Options: Y (enabled)|N (disabled)
          loadBalancerRuleList.N.serverProtocolTypeCodeNoString- Server protocol type code
          It can be set only when the loadBalancerRuleList.N.protocolTypeCode value is HTTPS.
          Options : HTTP HTTPS
          Default : HTTP
          regionNoNoStringYou can get a region number when creating a load balancer and create it in a specific region.
          You can obtain the region number through the getRegionList action.
          It'll be allocated in a random zone in the KR region if both region and zone are not entered.
          zoneNoListNoListYou can get a zone number when creating a load balancer and create it in a specific zone.
          You can obtain the zone number through the getZoneList action.
          Only one zone can be selected for a private IP load balancer. Multi-zone feature support is planned.

          Response

          Response body

          Examples

          Request examples

          GET {LOADBALANCER_API_URL}/loadbalancer/v2/createLoadBalancerInstance?loadBalancerRuleList.1.l7HealthCheckPath=/l7check.html&loadBalancerRuleList.1.loadBalancerPort=80&loadBalancerRuleList.1.protocolTypeCode=HTTP&loadBalancerRuleList.1.serverPort=80

          Response examples

          <createLoadBalancerInstanceResponse>
  <requestId>db3af87b-4d25-4cdd-b12a-caf220e1fee2</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerInstanceList>
    <loadBalancerInstance>
      <loadBalancerInstanceNo>1083198</loadBalancerInstanceNo>
      <virtualIp>49.236.150.49,49.236.151.137</virtualIp>
      <loadBalancerName>loadb1674dfbe5f4</loadBalancerName>
      <zoneList>
        <zone>
          <zoneNo>2</zoneNo>
          <zoneName>KR-1</zoneName>
          <zoneCode>KR-1</zoneCode>
          <zoneDescription>Gasan zone</zoneDescription>
          <regionNo>1</regionNo>
        </zone>
        <zone>
          <zoneNo>3</zoneNo>
          <zoneName>KR-2</zoneName>
          <zoneCode>KR-2</zoneCode>
          <zoneDescription>Pyeongchon zone</zoneDescription>
          <regionNo>1</regionNo>
        </zone>
      </zoneList>
      <region>
        <regionNo>1</regionNo>
        <regionCode>KR</regionCode>
        <regionName>Korea</regionName>
      </region>
      <loadBalancerAlgorithmType>
        <code>RR</code>
        <codeName>Round Robin</codeName>
      </loadBalancerAlgorithmType>
      <loadBalancerDescription></loadBalancerDescription>
      <createDate>2018-11-26T12:06:53+0900</createDate>
      <domainName>slb-1083198.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>
      <loadBalancerRuleList>
        <loadBalancerRule>
          <protocolType>
            <code>HTTP</code>
            <codeName>http</codeName>
          </protocolType>
          <loadBalancerPort>80</loadBalancerPort>
          <serverPort>80</serverPort>
          <l7HealthCheckPath>/l7check.html</l7HealthCheckPath>
          <certificateName></certificateName>
          <proxyProtocolUseYn>N</proxyProtocolUseYn>
          <stickySessionUseYn>N</stickySessionUseYn>
          <http2UseYn>N</http2UseYn>
        </loadBalancerRule>
      </loadBalancerRuleList>
      <loadBalancedServerInstanceList/>
    </loadBalancerInstance>
  </loadBalancerInstanceList>
</createLoadBalancerInstanceResponse>

          Error codes

          Errors that may occur while using this action are listed below. For more information about common errors, please refer to NAVER Cloud Platform API.

          HTTP Response CodeReturn codeReturn message
          40010300Instance name is already in use. please use other name.
          40010105Unable to create load balancer anymore since contract limitation setting has been exceeded. Number of contract limitation: {0} Number of current contracts : {1}
          40023011We are sorry that {0} cannot be used for load balancer ports since the ports are in use for load balancer management.
          40023017This version of the load balancer can not create with private IP.
          40023018Can not create the load balancer.
          40023019There is no resource for the load balancer.
          40024063The number of load balancer settings has been exceeded.
          40024064The range of usable {0} port is from 1 to 66534.
          40024065{0} Duplicated port number. Port number : {1}
          40024066When setting load balancer, Health Check route must be configured to HTTP protocol.
          40024091No IP address is assigned to the server instance (no. {0}).
          40024099When setting load balancer, Health Check route must be configured to HTTP or HTTPS protocol.
          40024109The input parameter instance number is invalid
          40024111The input parameter zone number is invalid.
          40024120The input parameter server instance number is invalid.
          40024130The input parameter load balancing algorithm is invalid.
          40024131The field {0} in the load balancer rule parameter 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.
          40024133The field healthCheckPath in the load balancer rule parameter is invalid. If the protocol is NOT HTTP, it must not be specified.
          40024134The number of input parameter load balancer rules is the minimum of 1, maximum of 5.
          40024173Only one zone can be selected for private IP load balancer.
          40024300The length constraints of the parameter description (memo) were violated. The minimum length is 0 byte, the maximum, 1,000 bytes.
          40025050(Other)Unable to operate load balancer since use is manipulating the applying server.
          40025051Server is already being applied to load balancer.
          40025052Server {0} is unable to apply to load balancer since it is either in operation or not being suspended.
          40026034An error occurred during certificate verification.
          40026035Not found memberNo OR certificateName. Please check your input parameter.
          40026036Not found memberNo OR certificateName OR privateKey OR publicKeyCertificate. Please check your input parameter.
          40026037Certificate is being used in another loadBalancer.
          40026002The issuer certificate of a looked up certificate could not be found. This normally means the list of trusted certificates is not complete.
          40026003The CRL of a certificate could not be found.
          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 keys.
          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. Unused.
          40026006The public key in the certificate SubjectPublicKeyInfo could not be read.
          40026007The signature of the certificate is invalid.
          40026008The signature of the certificate is invalid.
          40026009The certificate is not yet valid: the notBefore date is after the current time.
          40026010The certificate has expired: that is the notAfter date is before the current time.
          40026011The CRL is not yet valid.
          40026012The CRL has expired.
          40026013The certificate notBefore field contains an invalid time.
          40026014The certificate notAfter field contains an invalid time.
          40026015The CRL lastUpdate field contains an invalid time.
          40026016The CRL nextUpdate field contains an invalid time.
          40026017An error occurred trying to allocate memory. This should never happen.
          40026018The passed certificate is self signed and the same certificate cannot be 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 locally.
          40026020The issuer certificate could not be found: this occurs if the issuer certificate of an untrusted certificate cannot be found.
          40026021No signatures could be verified because the chain contains only one certificate and it is not self signed.
          40026022The certificate chain length is greater than the supplied maximum depth. Unused.
          40026023The certificate has been revoked.
          40026024A CA certificate is invalid. Either it is not a CA or its extensions are not consistent with the supplied purpose.
          40026025The basicConstraints pathlength parameter has been exceeded.
          40026026The supplied certificate cannot be used for the specified purpose.
          40026027The root CA is not marked as trusted for the specified purpose.
          40026028The root CA is marked to reject the specified purpose.
          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 set.
          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 set.
          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 set.
          40026032The current candidate issuer certificate was rejected because its keyUsage extension does not permit certificate signing.
          40026033An application specific error. Unused.
          40026034An error occurred during certificate verification.
          40026035Not found memberNo OR certificateName. Please check your input parameter.
          40026036Not found memberNo OR certificateName OR privateKey OR publicKeyCertificate. Please check your input parameter.
          40026037Certificate is being used in another loadBalancer.
          40026038The certificate name required for SSL/HTTPS. Please check your input parameter.
          40026042Proxy protocol can be set only with TCP, SSL protocols.
          Was this article helpful?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          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.
          Logout