createLoadBalancerInstance

Prev Next

VPC環境で利用できます。

概要

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

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
regionCode No String - リージョンコード
ロードバランサインスタンスが作成されるリージョン(Region)を決定
regionCodeはgetRegionListアクションを通じて取得
デフォルト: getRegionList照会結果の最初のリージョンを選択
loadBalancerTypeCode Yes String - ロードバランサのタイプコード
ロードバランサのタイプを決定
オプション: APPLICATION | NETWORK | NETWORK_PROXY
loadBalancerName No String 最小: 3, 最大: 30
英数字、記号の「-」のみ入力可能で、先頭文字は英字に、
末尾文字は英字または数字にする		 - ロードバランサの名前
デフォルト: NAVERクラウドプラットフォームが自動で付与
loadBalancerNetworkTypeCode No String - ロードバランサのネットワークタイプコード
オプション: PUBLIC | PRIVATE
デフォルト: PUBLIC
throughputTypeCode No String - 負荷処理性能のタイプコード
オプション: SMALL | MEDIUM | LARGE | XLARGE
デフォルト: SMALL
ロードバランサのタイプによって選択できる値が制限される

アプリケーション、ネットワークプロキシロードバランサ: SMALL(デフォルト) | MEDIUM | LARGE | XLARGE
ネットワークロードバランサ: DYNAMIC (デフォルト)
idleTimeout No Integer 最小: 1、最大: 3600秒 - 接続維持時間
ロードバランサのタイプが NETWORKでない場合にのみ有効
デフォルト: 60(秒)
vpcNo Yes String - VPC番号
ロードバランサインスタンスが作成されるVPCを決定
vpcNoは、getVpcListアクションを通じて取得
loadBalancerDescription No String 作成するロードバランサインスタンスについての説明
subnetNoList.N Conditional List<String> - Subnet番号リスト
subnetNoListと loadBalancerSubnetListの2つのうち、1つは必ず入力
subnetNoListと loadBalancerSubnetListを両方とも渡す場合、loadBalancerSubnetListを適用
選択した VPCに位置する Subnetを選択
ZONEごとに一つのロードバランサ専用 Subnetを選択できる
subnetNoはgetSubnetListアクションを通じて取得可能
例) subnetNoList.1=1234&subnetNoList.2=2345
loadBalancerSubnetList.N.subnetNo Conditional String - Subnet番号
subnetNoListと loadBalancerSubnetListの2つのうち、1つは必ず入力
subnetNoListと loadBalancerSubnetListを両方とも渡す場合、loadBalancerSubnetListを適用
loadBalancerSubnetList適用時、loadBalancerSubnetList.N.subnetNoは必須
選択した VPCに位置する Subnetを選択
ZONEごとに一つのロードバランサ専用 Subnetを選択できる
subnetNoはgetSubnetListアクションを通じて取得可能
loadBalancerSubnetList.N.publicIpInstanceNo No String - グローバル IPアドレスインスタンス番号
loadBalancerNetworkTypeCodeが PUBLICの場合にのみ有効
SGN(シンガポール)リージョンでのみ利用可能
デフォルト: 新しいグローバル IPアドレスを作成して割り当て
loadBalancerListenerList.N.protocolTypeCode No String - ロードバランサリスナーのプロトコルタイプコード
ロードバランサのタイプに応じて使用可能なリスナープロトコルタイプとデフォルト値を決定
APPLICATION : HTTP (Default) / HTTPS
NETWORK : TCP (Default) / UDP
NETWORK_PROXY : TCP (Default) / TLS
UDPプロトコルは SGN(シンガポール)リージョンでのみ利用可能
loadBalancerListenerList.N.port No Integer 最小: 1, 最大: 65534 - ロードバランサリスナーのポート
リスナープロトコルタイプに応じてポートのデフォルト値を決定
デフォルト:
HTTP / TCP / UDP : 80
HTTPS / TLS : 443
ポート番号は重複不可
loadBalancerListenerList.N.targetGroupNo Yes String - ターゲットグループ番号
選択したターゲットグループは各リスナーのデフォルトルールに適用
他のロードバランサで既に使用中のターゲットグループは利用不可
ロードバランサのタイプとターゲットグループのプロトコルタイプに応じて使用可能なターゲットグループが制限
NETWORK : TCP \ UDP
NETWORK_PROXY : PROXY_TCP
APPLICATION : HTTP / HTTPS
targetGroupNoはgetTargetGroupListアクションを通じて取得
loadBalancerListenerList.N.useHttp2 No Boolean - HTTP/2プロトコルの使用有無
オプション: true | false
デフォルト: false
リスナーのプロトコルタイプが HTTPSである場合にのみ有効
loadBalancerListenerList.N.sslCertificateNo Conditional String - SSL証明書番号
リスナーのプロトコルタイプが HTTPSまたは TLSである場合、SSL証明書の設定は必須
sslCertificateNoはGET https://certificatemanager.apigw.ntruss.com/api/v1/certificatesアクションを通じて取得
loadBalancerListenerList.N.tlsMinVersionTypeCode No String - TLS最小サポートバージョンタイプコード
リスナーのプロトコルタイプが HTTPSまたは TLSである場合にのみ有効
オプション:
TLSV10 (TLSv1.0)
TLSV11 (TLSv1.1)
TLSV12 (TLSv1.2)
デフォルト: TLSV10
loadBalancerListenerList.N.cipherSuiteList.N No List<String> - 暗号スイートリスト
ロードバランサがクライアントとの暗号化ネゴシエーションで提供する暗号化機能を選択
リスナーのプロトコルタイプが HTTPS / TLSである場合にのみ指定できる
オプション:
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
デフォルト: Select All
responseFormatType No String - レスポンス結果の形式タイプ
オプション: xml | json
デフォルト: xml

レスポンス

レスポンスデータタイプ

  • LoadBalancerInstanceListタイプ
LoadBalancerInstanceList extends CommonResponse
private Integer totalRows;
private List loadBalancerInstanceList = new ArrayList<>();
LoadBalancerInstance
private String loadBalancerInstanceNo;
private CommonCode loadBalancerInstanceStatus;
private CommonCode loadBalancerInstanceOperation;
private String loadBalancerInstanceStatusName;
private String loadBalancerDescription;
private Date createDate;
private String loadBalancerName;
private String loadBalancerDomain;
private LoadBalancerIpList loadBalancerIpList;
private CommonCode loadBalancerType;
private CommonCode loadBalancerNetworkType;
private CommonCode throughputType;
private Integer idleTimeout;
private String vpcNo;
private String regionCode;
private SubnetNoList subnetNoList;
private List<LoadBalancerSubnet> loadBalancerSubnetList;
private LoadBalancerListenerNoList loadBalancerListenerNoList;
LoadBalancerIpList
private List loadBalancerIpList = new ArrayList<>();
SubnetNoList
private List subnetNoList = new ArrayList<>();
LoadBalancerSubnet
private String zoneCode;
private String subnetNo;
private String publicIpInstanceNo;
LoadBalancerListenerNoList
private List loadBalancerListenerNoList = new ArrayList<>();

例

リクエスト例

ncloud vloadbalancer createLoadBalancerInstance --regionCode KR --loadBalancerTypeCode APPLICATION --loadBalancerName test-*** --loadBalancerNetworkTypeCode PRIVATE --throughputTypeCode SMALL --idleTimeout 60 --vpcNo ***04 --subnetNoList ***43 --loadBalancerListenerList "protocolTypeCode='HTTP', port='80', targetGroupNo='***095'"

レスポンス例

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