createLoadBalancerInstance

Article Summary

Share feedback

Thanks for sharing your feedback!

Available in VPC

Overview

Creates load balancer instances.

Requests

Request parameters

Parameter name	Required	Type	Service limits	Description
regionCode	No	String		- Region code You can decide the Region where the load balancer instance is to be created regionCode can be obtained through the getRegionList action Default: Select the first region from getRegionList search results
loadBalancerTypeCode	Yes	String		- Load balancer type code Determine the load balancer type Options : APPLICATION \| NETWORK \| NETWORK_PROXY
loadBalancerName	No	String	Min : 3, Max : 30 Only English letters, numbers, and the special character "-" can be used. It must start with an English letter It must end with an English letter or number	- Load balancer name Default: NAVER Cloud Platform automatically assigns it
loadBalancerNetworkTypeCode	No	String		- Load balancer network type code Options : PUBLIC
throughputTypeCode	No	String		- Load balancing performance type code APPLICATION, NETWORK_PROXY types Options : SMALL \| MEDIUM \| LARGE Default : SMALL NETWORK type Options : DYNAMIC Default : DYNAMIC
idleTimeout	No	Integer	Min: 1, Max: 3600 (seconds)	- Connection hold time Valid only if the load balancer type is not NETWORK Default: 60 (seconds)
vpcNo	Yes	String		- VPC number Determine the VPC where the load balancer instance will be created vpcNo can be obtained through the getVpcList action
loadBalancerDescription	No	String		Description of the load balancer instance to be created
subnetNoList.N	Conditional	List<String>		- List of the subnet numbers Either subnetNoList or loadBalancerSubnetList must be entered loadBalancerSubnetList is applied when sending both subnetNoList and loadBalancerSubnetList Select the subnet located in the selected VPC One dedicated subnet for load balancer per zone can be selected subnetNo can be obtained through the getSubnetList action ex) subnetNoList.1=1234&subnetNoList.2=2345
loadBalancerSubnetList.N.subnetNo	Conditional	String		- Subnet number Either subnetNoList or loadBalancerSubnetList must be entered loadBalancerSubnetList is applied when sending both subnetNoList and loadBalancerSubnetList loadBalancerSubnetList is applied when loadBalancerSubnetList.N.subnetNo is required Select the subnet located in the selected VPC One dedicated subnet for load balancer per zone can be selected subnetNo can be obtained through the getSubnetList action
loadBalancerSubnetList.N.publicIpInstanceNo	No	String		- Public IP instance number It's only valid when loadBalancerNetworkTypeCode is PUBLIC Only available in SGN (Singapore) and JPN (Japan) regions Default: A new public IP is created and assigned
loadBalancerListenerList.N.protocolTypeCode	No	String		- Load balancer listener protocol type code Available type of listener protocols and default value are determined by the load balancer type `APPLICATION : HTTP (Default) / HTTPS` `NETWORK : TCP (Default) / UDP` `NETWORK_PROXY : TCP (Default) / TLS` UDP protocol is available only in SGN (Singapore) and JPN (Japan) Regions
loadBalancerListenerList.N.port	No	Integer	Min : 1, Max : 65534	- Load balancer listener port Default port value is determined by the listener protocol type Default : `HTTP / TCP / UDP : 80` `HTTPS / TLS : 443` Port number must be unique
loadBalancerListenerList.N.targetGroupNo	Yes	String		- Target group number Selected target group applies to the DEFAULT rule of each listener You can't use a target group already in use by other load balancers Available target group is limited by the load balancer type and target group protocol type `NETWORK : TCP / UDP` `NETWORK_PROXY : PROXY_TCP` `APPLICATION : HTTP / HTTPS` You can obtain targetGroupNo through getTargetGroupList action
loadBalancerListenerList.N.useHttp2	No	Boolean		HTTP/2 protocol usage status Options : true \| false Default : false Valid only if the listener protocol type is HTTPS
loadBalancerListenerList.N.sslCertificateNo	Conditional	String		- SSL certificate number If the listener protocol type is either HTTPS or TLS, you must set the SSL certificate You can obtain the sslCertificateNo through the GET https://certificatemanager.apigw.ntruss.com/api/v1/certificates action
loadBalancerListenerList.N.tlsMinVersionTypeCode	No	String		- Minimum support version type code of TLS Valid only if the listener protocol type is either HTTPS or TLS Options : `TLSV10 (TLSv1.0)` `TLSV11 (TLSv1.1)` `TLSV12 (TLSv1.2)` Default : TLSV10
loadBalancerListenerList.N.cipherSuiteList.N	No	List<String>		- Cipher suite list Select the encryption features to be provided by the load balancer in encryption negotiation with the client Valid only if the listener protocol type is HTTPS/TLS Options : `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` Default : Select All
responseFormatType	No	String		- Format type of the response result Options : xml \| json Default : xml

Responses

Response bodies

LoadBalancerInstanceList

Examples

Request examples

GET {API_URL}/createLoadBalancerInstance
?regionCode=KR
&loadBalancerTypeCode=APPLICATION
&loadBalancerName=test-***
&loadBalancerNetworkTypeCode=PRIVATE
&throughputTypeCode=SMALL
&idleTimeout=60
&vpcNo=***04
&subnetNoList.1=***43
&loadBalancerListenerList.1.protocolTypeCode=HTTP
&loadBalancerListenerList.1.port=80
&loadBalancerListenerList.1.targetGroupNo=***095

Response examples

<createLoadBalancerInstanceResponse>
  <requestId>959a2fe5-fd1b-459a-9af3-df0e51b68e1d</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerInstanceList>
    <loadBalancerInstance>
      <loadBalancerInstanceNo>***887</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>2020-12-20T19:21:02+0900</createDate>
      <loadBalancerName>test-***</loadBalancerName>
      <loadBalancerDomain>test-***-***887-***.com</loadBalancerDomain>
      <loadBalancerIpList>
        <loadBalancerIp>***.***.5.6</loadBalancerIp>
      </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>***04</vpcNo>
      <regionCode>KR</regionCode>
      <subnetNoList>
        <subnetNo>***43</subnetNo>
      </subnetNoList>
      <loadBalancerSubnetList>
        <loadBalancerSubnet>
          <zoneCode>KR-1</zoneCode>
          <subnetNo>***43</subnetNo>
          <publicIpInstanceNo/>
        </loadBalancerSubnet>
      </loadBalancerSubnetList>
      <loadBalancerListenerNoList>
        <loadBalancerListenerNo>***961</loadBalancerListenerNo>
      </loadBalancerListenerNoList>
    </loadBalancerInstance>
  </loadBalancerInstanceList>
</createLoadBalancerInstanceResponse>

Was this article helpful?

What's Next

deleteLoadBalancerInstances

Table of contents

Overview
Requests
Responses
Examples