createLoadBalancerListener

VPC環境で利用できます。

ロードバランサに登録する新しいリスナーを作成します。

リクエスト

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

メソッド	URI
GET	/createLoadBalancerListener

リクエストヘッダ

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

リクエストクエリパラメータ

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リスナー作成対象のロードバランサインスタンスのリージョンコード getRegionList照会結果の最初のリージョン(デフォルト) getRegionListを通じて確認
`loadBalancerInstanceNo`	String	Required	ロードバランサインスタンスの番号 getLoadBalancerInstanceListを通じて確認
`protocolTypeCode`	String	Required	ロードバランサリスナーのプロトコルタイプ `HTTP` \| `HTTPS` \| `TCP` \| `UDP` \| `TLS` ロードバランサのタイプに応じて選択可能な値が制限されるアプリケーションロードバランサ: `HTTP` \| `HTTPS` ネットワークロードバランサ: `TCP` \| `UDP` ネットワークプロキシロードバランサ: `TCP` \| `TLS` `UDP`プロトコルはシンガポール、日本リージョンでのみ利用可能
`port`	Integer	Required	リスナーポート 1~65534 現在登録されているリスナーポートと重複不可
`targetGroupNo`	String	Required	ターゲットグループの番号 getTargetGroupListを通じて確認選択したターゲットグループはリスナーの基本ルールに適用される他のロードバランサで使用中のターゲットグループは利用不可ロードバランサのタイプとターゲットグループのプロトコルタイプに応じて選択可能なターゲットグループが制限されるネットワークロードバランサ: `TCP` \| `UDP` アプリケーションロードバランサ: `HTTP` \| `HTTPS` ネットワークプロキシロードバランサ: `PROXY_TCP`
`useHttp2`	Boolean	Optional	HTTP/2プロトコルの使用有無 `true` \| `false`(デフォルト) リスナーのプロトコルタイプが`HTTPS`の場合、設定可能
`sslCertificateNo`	String	Conditional	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` Select All(デフォルト) リスナーのプロトコルタイプが`HTTPS`または`TLS`の場合、設定可能
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

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}'

レスポンス

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

レスポンスボディ

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

レスポンスステータスコード

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

レスポンス例

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

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