createLoadBalancerInstance

Prev Next

Classic環境で利用できます。

概要

ロードバランサインスタンスの作成

説明

ロードバランサインスタンスを作成します。

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
loadBalancerName No String 最小:3、最大:30 - 作成するロードバランサ名
デフォルト:Ncloudで自動で割り当て
loadBalancerAlgorithmTypeCode No String 最小:1、最大:5 - ロードバランサのアルゴリズム区分コード
入力できるアルゴリズム:[ROUND ROBIN (RR) | LEAST_CONNECTION (LC)]
デフォルト:ROUND ROBIN (RR)
loadBalancerDescription No String 最小:1、最大:1000 作成時に入力するロードバランサの説明
serverInstanceNoList No List 重複不可 - ロードバランサにバインドするサーバインスタンス番号リスト
getLoadBalancancerTargetServerInstanceListアクションを通じてサーバインスタンス番号を照会可能
loadBalancerRuleList.protocolTypeCode Yes String 最小:1、最大:5 - ロードバランサルールのプロトコル区分コード
以下のようなコード入力可能:[HTTP | TCP]
loadBalancerRuleList.loadBalancerPort Yes Integer 最小:1、最大:65534 ロードバランサルールのロードバランサポート
loadBalancerRuleList.serverPort Yes Integer 最小:1、最大:65534 ロードバランサルールのサーバポート
loadBalancerRuleList.l7HealthCheckPath Conditional String 最小:1、最大:600 - ロードバランサルールのヘルスチェックパス
loadBalancerRuleList.N.protocolTypeCode値がHTTP/HTTPSの場合には必須項目
loadBalancerRuleList.certificateName Conditional String 最小:1、最大:300 - ロードバランサのSSL公認証明書
loadBalancerRuleList.protocloTypeCode値がSSL/HTTPSの場合には必須項目
loadBalancerRuleList.proxyProtocolUseYn No String 最小:1、最大:1 ロードバランサのルールリスト。プロキシプロトコルの使用有無
loadBalancerRuleList.N.stickySessionUseYn No String - セッション別アクセスの使用有無
loadBalancerRuleList.N.protocloTypeCode値がHTTP HTTPSの場合にのみ設定可能
オプション:Y(設定) | N(解除)
loadBalancerRuleList.N.http2UseYn No String - HTTP/2プロトコルの使用の有無
loadBalancerRuleList.N.protocloTypeCode値がHTTPSの場合にのみ設定可能
オプション:Y(設定) | N(解除)
loadBalancerRuleList.N.serverProtocolTypeCode No String - サーバプロトコル区分コード
loadBalancerRuleList.N.protocloTypeCode値がHTTPSの場合にのみ設定可能
オプション:HTTP HTTPS
デフォルト:HTTP
regionNo No String 入力可能な状態は、getRegionListアクションを通じて取得可能

レスポンスデータのタイプ

  • LoadBalancerInstanceListタイプ
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;

呼び出し

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

レスポンス

{
  "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>