createLoadBalancerListener

Prev Next

VPC環境で利用できます。

ロードバランサに登録する新しいリスナーを作成します。

構文

createLoadBalancerListener構文は次の通りです。

./ncloud vloadbalancer createLoadBalancerListener \
    --loadBalancerInstanceNo <load-balancer-instance-no> \
    --protocolTypeCode <HTTP|HTTPS|TCP|UDP|TLS> \
    --port <port> \
    --targetGroupNo <target-group-no> \
    [--useHttp2 <true|false>] \
    [--sslCertificateNo <ssl-certificate-no>] \
    [--tlsMinVersionTypeCode <TLSV10|TLSV11|TLSV12>] \
    [--cipherSuiteList <cipher-suite-list>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

createLoadBalancerListenerの実行時に指定できるオプションについて説明します。

必須オプション

createLoadBalancerListenerの必須オプションです。

オプション タイプ 必須の有無 説明
--loadBalancerInstanceNo String Required ロードバランサインスタンス番号
--protocolTypeCode String Required ロードバランサのリスナーのプロトコルタイプ
  • HTTP | HTTPS | TCP | UDP | TLS
  • ロードバランサのタイプによって、選択できる値に制限がある
    • アプリケーションロードバランサ: HTTP | HTTPS
    • ネットワークロードバランサ: TCP | UDP
    • ネットワークプロキシロードバランサ: TCP | TLS
  • UDPプロトコルは、シンガポールおよび日本のリージョンでのみ利用可能
--port Integer Required リスナーポート
  • 1~65534
  • 現在登録されているリスナーポートと重複不可
--targetGroupNo String Required ターゲットグループの番号
  • 選択したターゲットグループはリスナーのデフォルトルールに適用される
  • 他のロードバランサで使用中のターゲットグループは利用不可
  • ロードバランサのタイプやターゲットグループのプロトコルタイプによって、選択可能なターゲットグループが制限される
    • アプリケーションロードバランサ: HTTP | HTTPS
    • ネットワークロードバランサ: TCP | UDP
    • ネットワークプロキシロードバランサ: PROXY_TCP
  • getTargetGroupListを参照
--sslCertificateNo String Conditional SSL証明書番号
  • リスナーのプロトコルタイプがHTTPSまたはTLSの場合、SSL証明書の設定は必須
  • getCertificateListを参照

任意オプション

createLoadBalancerListenerの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--useHttp2 Boolean Optional HTTP/2プロトコルを使用するか
  • true | false (デフォルト)
    • true: 使用
    • false: 使用しない
  • リスナーのプロトコルタイプがHTTPSの場合、設定可能
--tlsMinVersionTypeCode String Optional TLS最小対応バージョン
  • TLSV10 (デフォルト) | TLSV11 | TLSV12
    • TLSV10: TLS 1.0
    • TLSV11: TLS 1.1
    • TLSV12: TLS 1.2
  • リスナーのプロトコルタイプがHTTPSまたはTLSの場合、設定可能
--cipherSuiteList List Optional クライアントとの暗号化ネゴシエーション時にロードバランサが提供する暗号ツールリスト
  • 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
  • デフォルト: すべて選択
  • リスナーのプロトコルタイプがHTTPSまたはTLSの場合、設定可能
  • スペースで区切って複数入力可能

共通オプション

vloadbalancerコマンドで共通して使用するオプションについては、Load Balancer (VPC)のオプションをご参照ください。

例

ロードバランサリスナーの作成リクエストが成功すると、ロードバランサに登録されたリスナーの構成情報が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vloadbalancer createLoadBalancerListener \
    --loadBalancerInstanceNo 41112223 \
    --protocolTypeCode HTTP \
    --port 8080 \
    --targetGroupNo 55667799 \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "createLoadBalancerListenerResponse": {
    "totalRows": 2,
    "loadBalancerListenerList": [
      {
        "loadBalancerInstanceNo": "41112223",
        "loadBalancerListenerNo": "60001111",
        "protocolType": {
          "code": "HTTP",
          "codeName": "HTTP protocol"
        },
        "port": 80,
        "useHttp2": false,
        "sslCertificateNo": "",
        "tlsMinVersionType": {},
        "loadBalancerRuleNoList": [
          "70001111"
        ],
        "cipherSuiteList": []
      },
      {
        "loadBalancerInstanceNo": "41112223",
        "loadBalancerListenerNo": "60002222",
        "protocolType": {
          "code": "HTTP",
          "codeName": "HTTP protocol"
        },
        "port": 8080,
        "useHttp2": false,
        "sslCertificateNo": "",
        "tlsMinVersionType": {},
        "loadBalancerRuleNoList": [
          "70002222"
        ],
        "cipherSuiteList": []
      }
    ],
    "requestId": "b8c9d0e1-f2a3-4567-bcde-890123456789",
    "returnCode": "0",
    "returnMessage": "success"
  }
}