createLoadBalancerInstance

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a Classic environment.

Overview

Creates a load balancer instance.

Description

Creates a load balancer instance.

Request parameter

Parameter name	Requirement status	Type	Restrictions	Description
loadBalancerName	No	String	Min: 3, Max: 30	- Name of the load balancer to be created Default: assigned by Ncloud
loadBalancerAlgorithmTypeCode	No	String	Min: 1, Max: 5	- Load balancer algorithm classification code Algorithms that can be entered: [ROUND ROBIN (RR) \| LEAST_CONNECTION (LC)] Default: ROUND ROBIN (RR)
loadBalancerDescription	No	String	Min: 1, Max: 1000	Description of the load balancer to be entered upon creation
serverInstanceNoList	No	List	It can't be duplicated.	- Server instance number list to be bound to the load balancer The server instance number can be searched through the getLoadBalancancerTargetServerInstanceList action.
loadBalancerRuleList.protocolTypeCode	Yes	String	Min: 1, Max: 5	- Protocol classification code of the load balancer rule The following code can be entered: [HTTP \| TCP]
loadBalancerRuleList.loadBalancerPort	Yes	Integer	Min: 1, Max: 65534	Load balancer port of the load balancer rule
loadBalancerRuleList.serverPort	Yes	Integer	Min: 1, Max: 65534	Server port for the load balancer rule
loadBalancerRuleList.l7HealthCheckPath	Conditional	String	Min: 1, Max: 600	- Health check path of the load balancer rule Required field if the loadBalancerRuleList.N.protocolTypeCode value is HTTP/HTTPS
loadBalancerRuleList.certificateName	Conditional	String	Min: 1, Max: 300	- Load balancer's SSL public certificate Required field if the loadBalancerRuleList.protocloTypeCode value is SSL/HTTPS.
loadBalancerRuleList.proxyProtocolUseYn	No	String	Min: 1, Max: 1	Load balancer rule list. Proxy protocol use status
loadBalancerRuleList.N.stickySessionUseYn	No	String		- Access by session usage status It can only be set when the loadBalancerRuleList.N.protocloTypeCode value is `HTTP` `HTTPS`. Options: `Y (enabled)`\|`N (disabled)`
loadBalancerRuleList.N.http2UseYn	No	String		- HTTP/2 protocol use status It can only be set when the loadBalancerRuleList.N.protocloTypeCode value is `HTTPS`. Options: `Y (enabled)`\|`N (disabled)`
loadBalancerRuleList.N.serverProtocolTypeCode	No	String		- Server protocol classification code It can only be set when the loadBalancerRuleList.N.protocloTypeCode value is `HTTPS`. Options: `HTTP` `HTTPS` Default: `HTTP`
regionNo	No	String		You can obtain the status where input is possible through the getRegionList action.

Response data type

LoadBalancerInstanceList type

LoadBalancerInstanceList extends CommonResponse
private Integer totalRows;
private List<LoadBalancerInstance> loadBalancerInstanceList = new ArrayList();

LoadBalancerInstance
private String loadBalancerInstanceNo;
private String virtualIp;
private String loadBalancerName;
private CommonCode loadBalancerAlgorithmType;
private String loadBalancerDescription;
private Date createDate;
private String domainName;
private String loadBalancerInstanceStatusName;
private CommonCode loadBalancerInstanceStatus;
private CommonCode loadBalancerInstanceOperation;
private CommonCode networkUsageType;
private boolean isHttpKeepAlive;
private Integer connectionTimeout;
private String certificateName;
private List loadBalancerRuleList;
private List loadBalancedServerInstanceList;

Examples

Call

ncloud loadbalancer createLoadBalancerInstance --loadBalancerName penguin --loadBalancerRuleList "protocolTypeCode=HTTP,loadBalancerPort=80,serverPort=80,l7HealthCheckPath='/l7check.html',proxyProtocolUseYn=N"

Response

{
  "createLoadBalancerInstanceResponse": {
    "requestId": "2e636399-add9-4b7d-8714-91a87740af74",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "loadBalancerInstanceList": [
      {
          "loadBalancerInstanceNo": 465900,
          "virtualIp": "49.236.164.52,49.236.164.96",
          "loadBalancerName": "penguin",
          "loadBalancerAlgorithmType": {
            "code": "RR",
            "codeName": "Round Robin"
          },
          "loadBalancerDescription": "",
          "createDate": "0572-12-03T15:19:16+0900",
          "domainName": "slb-465900.ncloudslb.com",
          "loadBalancerInstanceStatusName": "creating",
          "loadBalancerInstanceStatus": {
            "code": "INIT",
            "codeName": "NET INIT state"
          },
          "loadBalancerInstanceOperation": {
            "code": "USE",
            "codeName": "NET USE OP"
          },
          "networkUsageType": {
            "code": "PBLIP",
            "codeName": "Public"
          },
          "isHttpKeepAlive": false,
          "connectionTimeout": 60,
          "certificateName": "",
          "loadBalancerRuleList": [
            {
                "protocolType": {
                  "code": "HTTP",
                  "codeName": "http"
                },
                "loadBalancerPort": 80,
                "serverPort": 80,
                "l7HealthCheckPath": "/l7check.html",
                "certificateName": "",
                "proxyProtocolUseYn": "N",
                "stickySessionUseYn": "N",
                "http2UseYn": "N"
            }
          ],
          "loadBalancedServerInstanceList": [
            ""
          ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<createLoadBalancerInstanceResponse>
  <requestId>2e636399-add9-4b7d-8714-91a87740af74</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerInstanceList>
    <loadBalancerInstanceNo>465900</loadBalancerInstanceNo>
    <virtualIp>49.236.164.52,49.236.164.96</virtualIp>
    <loadBalancerName>penguin</loadBalancerName>
    <loadBalancerAlgorithmType>
      <code>RR</code>
      <codeName>Round Robin</codeName>
    </loadBalancerAlgorithmType>
    <loadBalancerDescription></loadBalancerDescription>
    <createDate>0572-12-03T15:19:16+0900</createDate>
    <domainName>slb-465900.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>
      <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>
    </loadBalancerRuleList>
    <loadBalancedServerInstanceList></loadBalancedServerInstanceList>
  </loadBalancerInstanceList>
</createLoadBalancerInstanceResponse>

Was this article helpful?

What's Next

getLoadBalancerTargetServerInstanceList

Table of contents

Overview
Description
Request parameter
Response data type
Examples