createLoadBalancerListener

Prev Next

Available in VPC

Create a new listener to register with a load balancer.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /createLoadBalancerListener

Request headers

For headers common to all Load Balancer APIs, see Load Balancer common headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code for the load balancer instance whose listener you want to create
  • First Region of the getRegionList search result (default)
  • Check through getRegionList
loadBalancerInstanceNo String Required Number of the load balancer instance
protocolTypeCode String Required Protocol type of load balancer listener
  • HTTP | HTTPS | TCP | UDP | TLS
  • Type of load balancer limits the values you can select
    • Application Load Balancer: HTTP | HTTPS
    • Network Load Balancer: TCP | UDP
    • Network Proxy Load Balancer: TCP | TLS
  • UDP protocol is only available in Singapore and Japan Regions
port Integer Required Port of the listener
  • 1 - 65534
  • It can't be duplicated with an existing registered listener port
targetGroupNo String Required Target group number
  • Check through getTargetGroupList
  • Selected target group is applied to the listener's default rule
  • Target groups already in use by another load balancer can't be used
  • Available target groups are limited by the type of load balancer and the protocol type of the target group
    • Network Load Balancer: TCP | UDP
    • Application Load Balancer: HTTP | HTTPS
    • Network Proxy Load Balancer: PROXY_TCP
useHttp2 Boolean Optional Whether to use the HTTP/2 protocol
  • true | false (default)
  • It can be set if the listener's protocol type is HTTPS
sslCertificateNo String Conditional SSL certificate number
  • Check through getCertificateList
  • If the listener's protocol type is HTTPS or TLS, the SSL certificate must be set
tlsMinVersionTypeCode String Optional TLS minimum supported version
  • TLSV10 (default) | TLSV11 | TLSV12
    • TLSV10: TLS 1.0
    • TLSV11: TLS 1.1
    • TLSV12: TLS 1.2
  • It can be set if the listener's protocol type is HTTPS or TLS
cipherSuiteList.N List<String> Optional List of encryption tools provided by the load balancer when negotiating encryption 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
  • Select All (default)
  • It can be set if the listener's protocol type is HTTPS or TLS
responseFormatType String Optional Response result format
  • xml (default) | json

Request example

The following is a sample request.

curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/createLoadBalancerListener
?regionCode=KR
&loadBalancerInstanceNo=********
&protocolTypeCode=HTTP
&port=80
&targetGroupNo=*******'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

See LoadBalancerListenerList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

<createLoadBalancerListenerResponse>
    <requestId>05993e9c-1c80-458d-b7b6-e84c84b6812a</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <loadBalancerListenerList>
        <loadBalancerListener>
            <loadBalancerInstanceNo>********</loadBalancerInstanceNo>
            <loadBalancerListenerNo>******</loadBalancerListenerNo>
            <protocolType>
                <code>HTTP</code>
                <codeName>HTTP protocol</codeName>
            </protocolType>
            <port>80</port>
            <useHttp2>false</useHttp2>
            <sslCertificateNo></sslCertificateNo>
            <tlsMinVersionType/>
            <loadBalancerRuleNoList>
                <loadBalancerRuleNo>******</loadBalancerRuleNo>
            </loadBalancerRuleNoList>
            <cipherSuiteList/>
        </loadBalancerListener>
    </loadBalancerListenerList>
</createLoadBalancerListenerResponse>