changeLoadBalancerListenerConfiguration

Prev Next

VPC環境で利用できます。

ロードバランサリスナーの設定を変更します。

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /changeLoadBalancerListenerConfiguration

Load Balancer APIで共通して使用されるヘッダの詳細は、Load Balancerの共通ヘッダをご参照ください。

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リスナー設定変更対象のロードバランサインスタンスのリージョンコード
  • getRegionList照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
loadBalancerListenerNo String Required ロードバランサリスナーの番号
protocolTypeCode String Required ロードバランサリスナーのプロトコルタイプ
  • HTTP | HTTPS | TCP | UDP | TLS
  • ロードバランサのタイプに応じて選択可能な値が制限される
    • アプリケーションロードバランサ: HTTP | HTTPS
    • ネットワークロードバランサ: TCP | UDP
    • ネットワークプロキシロードバランサ: TCP | TLS
  • UDPプロトコルはシンガポール、日本リージョンでのみ利用可能
port Integer Required ロードバランサリスナーのポート
  • 1~65534
  • 現在登録されているリスナーポートと重複不可
useHttp2 Boolean Optional HTTP/2プロトコルの使用有無
  • true | false(デフォルト)
  • リスナーのプロトコルタイプがHTTPSの場合、設定可能
sslCertificateNo String Required SSL証明書番号
  • getCertificateListを通じて確認
  • リスナーのプロトコルタイプがHTTPSまたはTLSの場合、SSL証明書設定は必須
tlsMinVersionTypeCode String Optional TLSの最小サポートバージョン
  • TLSV10(デフォルト) | TLSV11 | TLSV12
    • TLSV10: TLS 1.0
    • TLSV11: TLS 1.1
    • TLSV12: TLS 1.2
  • リスナーのプロトコルタイプがHTTPSまたはTLSの場合、設定可能
cipherSuiteList.N List<String> 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に新規設定する場合、Select All
    • リスナープロトコルを変更しない場合、既存設定を維持
  • リスナーのプロトコルタイプがHTTPSまたはTLSの場合、設定可能
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエストのサンプルコードは次の通りです。

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

レスポンス形式を説明します。

レスポンスボディの詳細は、LoadBalancerListenerListをご参照ください。

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンスのサンプルコードは次の通りです。

<changeLoadBalancerListenerConfigurationResponse>
    <requestId>af74a733-f275-45c4-9797-fa7d0f3a607d</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>
</changeLoadBalancerListenerConfigurationResponse>
XML