createLoadBalancerInstance

Prev Next

VPC環境で利用できます。

ロードバランサインスタンスを作成します。

リクエスト

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

メソッド URI
GET /createLoadBalancerInstance

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 作成するロードバランサインスタンスのリージョンコード
  • getRegionList照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
loadBalancerTypeCode String Required ロードバランサタイプ
  • APPLICATION | NETWORK | NETWORK_PROXY
loadBalancerName String Optional ロードバランサの名前
  • NAVERクラウドプラットフォームが自動付与(デフォルト)
  • 英数字、記号の「-」を使用して3~30文字以内で入力、先頭文字は英字のみを、末尾文字は英字または数字のみ使用
loadBalancerNetworkTypeCode String Optional ロードバランサのネットワークタイプ
  • PUBLIC (デフォルト) | PRIVATE
throughputTypeCode String Optional 負荷処理性能タイプ
  • SMALL | MEDIUM | LARGE | DYNAMIC| XLARGE
  • ロードバランサのタイプによって選択できる値が制限される
    • アプリケーション、ネットワークプロキシロードバランサ: SMALL (デフォルト) | MEDIUM | LARGE| XLARGE
    • ネットワークロードバランサ: DYNAMIC (デフォルト)
idleTimeout Integer Optional 接続維持時間(秒)
  • 1~3,600 (デフォルト: 60)
  • ロードバランサのタイプがNETWORKの場合、設定不可
vpcNo String Required 作成するロードバランサの VPC番号
loadBalancerDescription String Optional ロードバランサの説明(Byte)
  • 0~1,000
subnetNoList.N List<String> Conditional サブネットの番号リスト
  • subnetNoListまたはloadBalancerSubnetListは必ず入力
    • すべて渡す場合、loadBalancerSubnetListを適用
  • 選択した VPCに位置するサブネットを選択
  • ゾーンごとに1つのロードバランサ専用サブネットを選択可能
  • subnetNoはgetSubnetListを通じて確認
  • <例> subnetNoList.1=1234&subnetNoList.2=2345
loadBalancerSubnetList.N.subnetNo String Conditional サブネット番号
  • subnetNoListまたはloadBalancerSubnetListは必ず入力
    • すべて渡す場合、loadBalancerSubnetListを適用
  • loadBalancerSubnetListを適用する場合、loadBalancerSubnetList.N.subnetNoは必須
  • 選択した VPCに位置するサブネットを選択
  • ゾーンごとに1つのロードバランサ専用サブネットを選択可能
  • subnetNoはgetSubnetListを通じて確認
loadBalancerSubnetList.N.publicIpInstanceNo String Optional グローバル IPアドレスインスタンス番号
  • 新しいグローバル IPアドレスを作成して割り当て(デフォルト)
  • ロードバランサのネットワークタイプがPUBLICの場合、設定可能
loadBalancerListenerList.N.protocolTypeCode String Optional ロードバランサリスナーのプロトコルタイプ
  • HTTP | HTTPS | TCP | UDP | TLS
  • ロードバランサのタイプに応じて選択可能な値が制限される
    • アプリケーションロードバランサ: HTTP (デフォルト) | HTTPS
    • ネットワークロードバランサ: TCP (デフォルト) | UDP
    • ネットワークプロキシロードバランサ: TCP (デフォルト) | TLS
loadBalancerListenerList.N.port Integer Optional ロードバランサリスナーのポート
  • 1~65534
  • リスナーのプロトコルタイプに応じてデフォルト値が決まる
    • HTTP、TCP、UDPプロトコル: 80
    • HTTPS、TLSプロトコル: 443
  • 現在登録されているリスナーポートと重複不可
loadBalancerListenerList.N.targetGroupNo String Required 各リスナーの基本ルールに適用されるターゲットグループ番号
  • targetGroupNoはgetTargetGroupListを通じて確認
  • ロードバランサのタイプとターゲットグループのプロトコルタイプに応じて使用可能なターゲットグループが制限される
    • アプリケーションロードバランサ: HTTP | HTTPS
    • ネットワークロードバランサ: TCP | UDP
    • ネットワークプロキシロードバランサ: PROXY_TCP
  • 他のロードバランサで既に使用中のターゲットグループは使用不可
loadBalancerListenerList.N.useHttp2 Boolean Optional HTTP/2プロトコルの使用有無
  • true | false (デフォルト)
  • リスナーのプロトコルタイプがHTTPSの場合、設定可能
loadBalancerListenerList.N.sslCertificateNo String Conditional SSL証明書番号
  • sslCertificateNoはgetCertificateListを通じて確認
  • リスナーのプロトコルタイプがHTTPSまたはTLSの場合、SSL証明書を必ず設定
loadBalancerListenerList.N.tlsMinVersionTypeCode String Optional TLSの最小サポートバージョン
  • TLSV10 (デフォルト) | TLSV11 | TLSV12 | TLSV13
    • TLSV10: TLS 1.0
    • TLSV11: TLS 1.1
    • TLSV12: TLS 1.2
    • TLSV13: TLS 1.3
  • リスナーのプロトコルタイプがHTTPSまたはTLSの場合、設定可能
  • TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_GCM_SHA256暗号化ツールは常に含める
loadBalancerListenerList.N.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/createLoadBalancerInstance
?regionCode=KR
&loadBalancerTypeCode=APPLICATION
&loadBalancerName=YOUR_LOAD_BALANCER
&loadBalancerNetworkTypeCode=PRIVATE
&throughputTypeCode=SMALL
&idleTimeout=60
&vpcNo=*****
&subnetNoList.1=******
&loadBalancerListenerList.1.protocolTypeCode=HTTP
&loadBalancerListenerList.1.port=80
&loadBalancerListenerList.1.targetGroupNo=*******'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

<createLoadBalancerInstanceResponse>
    <requestId>48df95ef-b0bc-4338-bbc8-7126965c0987</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <loadBalancerInstanceList>
        <loadBalancerInstance>
            <loadBalancerInstanceNo>********</loadBalancerInstanceNo>
            <loadBalancerInstanceStatus>
                <code>INIT</code>
                <codeName>LB INIT state</codeName>
            </loadBalancerInstanceStatus>
            <loadBalancerInstanceOperation>
                <code>CREAT</code>
                <codeName>LB CREATE OP</codeName>
            </loadBalancerInstanceOperation>
            <loadBalancerInstanceStatusName>Creating</loadBalancerInstanceStatusName>
            <loadBalancerDescription></loadBalancerDescription>
            <createDate>2024-06-03T18:52:28+0900</createDate>
            <loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
            <loadBalancerDomain>***.com</loadBalancerDomain>
            <loadBalancerIpList/>
            <loadBalancerType>
                <code>APPLICATION</code>
                <codeName>Application Load Balancer</codeName>
            </loadBalancerType>
            <loadBalancerNetworkType>
                <code>PRIVATE</code>
                <codeName>Private</codeName>
            </loadBalancerNetworkType>
            <throughputType>
                <code>SMALL</code>
                <codeName>Small</codeName>
            </throughputType>
            <idleTimeout>60</idleTimeout>
            <vpcNo>*****</vpcNo>
            <regionCode>KR</regionCode>
            <subnetNoList>
                <subnetNo>******</subnetNo>
            </subnetNoList>
            <loadBalancerSubnetList>
                <loadBalancerSubnet>
                    <zoneCode>KR-1</zoneCode>
                    <subnetNo>******</subnetNo>
                    <publicIpInstanceNo></publicIpInstanceNo>
                </loadBalancerSubnet>
            </loadBalancerSubnetList>
            <loadBalancerListenerNoList>
                <loadBalancerListenerNo>******</loadBalancerListenerNo>
            </loadBalancerListenerNoList>
        </loadBalancerInstance>
    </loadBalancerInstanceList>
</createLoadBalancerInstanceResponse>