createLoadBalancerListener

Article Summary

Share feedback

Thanks for sharing your feedback!

Can be used in a VPC environment.

Overview

Create new listeners in a load balancer.

Request

Request parameter

Parameter name	Requirement status	Type	Restrictions	Description
regionCode	No	String		- Region code You can decide the region of the load balancer instance where a load balancer listener will be created. You can obtain regionCode through the getRegionList action. Default: Selects the first region of the getRegionList search results.
loadBalancerInstanceNo	Yes	String		- Load balancer instance number You can obtain loadBalancerInstanceNo through the getLoadBalancerInstanceList action.
protocolTypeCode	Yes	String		- Listener protocol type code The available type of listener protocols is limited, depending on the selected load balancer type. `APPLICATION : HTTP / HTTPS` `NETWORK : TCP / UDP` `NETWORK_PROXY : TCP / TLS` The UDP protocol can only be used in the SGN (Singapore) region.
port	Yes	Integer	Min: 1, Max: 65534	- Listener port The listener port must be unique from the registered ones.
targetGroupNo	Yes	String		- Target group number The selected target group applies to the DEFAULT rule of each listener. You can't use the target group being used in other load balancers. The available target group is limited, depending on the load balancer type and target group protocol type. `NETWORK : TCP / UDP` `NETWORK_PROXY : PROXY_TCP` `APPLICATION : HTTP / HTTPS` You can obtain targetGroupNo through the getTargetGroupList action.
useHttp2	No	Boolean		HTTP/2 protocol use status Options: true \| false Default: false It is only valid if the listener protocol type is HTTPS.
sslCertificateNo	Conditional	String		- SSL certificate number If the listener protocol type is either HTTPS or TLS, you must set the SSL certificate. You can obtain sslCertificateNo through the GET https://certificatemanager.apigw.ntruss.com/api/v1/certificates action.
tlsMinVersionTypeCode	No	String		- Minimum support version type code of TLS It is only valid if the listener protocol type is either HTTPS or TLS. Options : `TLSV10 (TLSv1.0)` `TLSV11 (TLSv1.1)` `TLSV12 (TLSv1.2)` Default: TLSV10
cipherSuiteList.N	No	List<String>		- Cipher suite list Selects the encryption features to be provided by the load balancer in encryption negotiation with the client. It can only be specified if the listener protocol type is HTTPS or TLS. Options : `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
responseFormatType	No	String		- Format type of the response result Options: xml \| json Default: xml

Response

Response body

LoadBalancerListenerList

Examples

Request examples

GET {API_URL}/createLoadBalancerListener
?regionCode=KR
&loadBalancerInstanceNo=***887
&protocolTypeCode=HTTP
&port=80
&targetGroupNo=***095

Response examples

<createLoadBalancerListenerResponse>
  <requestId>55fc050c-3006-4472-bd96-2cb3b1547a53</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerListenerList>
    <loadBalancerListener>
      <loadBalancerInstanceNo>***887</loadBalancerInstanceNo>
      <loadBalancerListenerNo>***961</loadBalancerListenerNo>
      <protocolType>
        <code>HTTP</code>
        <codeName>HTTP protocol</codeName>
      </protocolType>
      <port>80</port>
      <useHttp2>false</useHttp2>
      <sslCertificateNo></sslCertificateNo>
      <tlsMinVersionType/>
      <loadBalancerRuleNoList>
        <loadBalancerRuleNo>***444</loadBalancerRuleNo>
      </loadBalancerRuleNoList>
      <cipherSuiteList/>
    </loadBalancerListener>
  </loadBalancerListenerList>
</createLoadBalancerListenerResponse>

Was this article helpful?

What's Next

deleteLoadBalancerListeners

Table of contents

Overview
Request
Response
Examples