createLoadBalancerListener

Available in VPC

Create a new listener to register with a load balancer.

Syntax

The createLoadBalancerListener syntax is as follows:

./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>]

Options

This section describes the options available when running createLoadBalancerListener.

Required options

The following options are required for createLoadBalancerListener.

Options	Type	Required	Description
`--loadBalancerInstanceNo`	String	Required	Load balancer instance number See getLoadBalancerInstanceList.
`--protocolTypeCode`	String	Required	Load balancer listener protocol type `HTTP` \| `HTTPS` \| `TCP` \| `UDP` \| `TLS` Available values are limited depending on the load balancer type. Application Load Balancer: `HTTP` \| `HTTPS` Network Load Balancer: `TCP` \| `UDP` Network Proxy Load Balancer: `TCP` \| `TLS` `UDP` protocol is available only in the Singapore and Japan Regions.
`--port`	Integer	Required	Listener port `1`-`65534` Can't duplicate with an existing listener port.
`--targetGroupNo`	String	Required	Target group number The selected target group is applied to the listener's default rule. Target groups used by other load balancers can't be selected. Available target groups are limited by the load balancer type and the target group protocol type. Application Load Balancer: `HTTP` \| `HTTPS` Network Load Balancer: `TCP` \| `UDP` Network Proxy Load Balancer: `PROXY_TCP` See getTargetGroupList.
`--sslCertificateNo`	String	Conditional	SSL certificate number An SSL certificate must be configured if the listener’s protocol type is `HTTPS` or `TLS`. See getCertificateList.

Optional options

These are the optional options for createLoadBalancerListener. Options that are not specified will use their default values.

Options	Type	Required	Description
`--useHttp2`	Boolean	Optional	Whether to use the HTTP/2 protocol `true` \| `false` (default) `true`: Enabled. `false`: Disabled. Can be set if the listener's protocol type is `HTTPS`.
`--tlsMinVersionTypeCode`	String	Optional	Minimum supported TLS version `TLSV10` (default) \| `TLSV11` \| `TLSV12` `TLSV10`: TLS 1.0 `TLSV11`: TLS 1.1 `TLSV12`: TLS 1.2 Can be set if the listener protocol type is `HTTPS` or `TLS`.
`--cipherSuiteList`	List	Optional	List of cipher suites provided by the load balancer during encryption negotiation with the client `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. Can be set if the listener protocol type is `HTTPS` or `TLS`. You can enter multiple items separated by spaces.

Common options

For information about the options common to all vloadbalancer subcommands, see Load Balancer (VPC) options.

Examples

If the request to create a load balancer listener is successful, the configuration information for the listener registered with the load balancer is returned.

Command

The command example is as follows:

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

Output

The output example is as follows:

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