changeLoadBalancerListenerConfiguration
  • PDF

changeLoadBalancerListenerConfiguration

  • PDF

Can be used in a VPC environment.

Overview

Changes the load balancer listener settings.

Request

Request parameter

Parameter name Requirement status Type Restrictions Description
regionCode No String - Region code
Decides the region of the load balancer instance to change the load balancer listener settings for.
regionCode can be obtained through the getRegionList action.
- Default: Selects the first region of the getRegionList search results.
loadBalancerListenerNo Yes String - Listener number of the load balancer to change settings for
loadBalancerListenerNo can be obtained through the getLoadBalancerListenerList action.
protocolTypeCode Yes String - Listener protocol type code
The available types of listener protocols are limited, depending on the load balancer type where the listener is registered.
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.
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.
sslCertificateNo can be obtained 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 if you are setting a new listener protocol as HTTPS or TLS.
The existing cipher suite configuration is maintained if there are no listener protocol changes.
responseFormatType No String - Format type of the response result
Options : xml | json
Default : xml

Response

Response data type

  • LoadBalancerListenerList type
LoadBalancerListenerList extends CommonResponse
private Integer totalRows;
private List loadBalancerListenerList = new ArrayList<>();
LoadBalancerListener
private String loadBalancerInstanceNo;
private String loadBalancerListenerNo;
private CommonCode protocolType;
private Integer port;
private Boolean useHttp2;
private String sslCertificateNo;
private CommonCode tlsMinVersionType;
private LoadBalancerRuleNoList loadBalancerRuleNoList;
private CipherSuiteList cipherSuiteList;
LoadBalancerRuleNoList
private List<String> loadBalancerRuleNoList = new ArrayList<>();
CipherSuiteList
private List<String> cipherSuiteList = new ArrayList<>();

Examples

Request examples

ncloud vloadbalancer changeLoadBalancerListenerConfiguration --regionCode KR --loadBalancerListenerNo ***961 --protocolTypeCode HTTP --port 80

Response examples

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

Was this article helpful?