createLoadBalancerInstance
    • PDF

    createLoadBalancerInstance

    • PDF

    記事の要約

    Classic環境で利用できます。

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

    リクエスト

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

    メソッドURI
    GET/createLoadBalancerInstance

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    loadBalancerNameStringOptional作成するロードバランサの名前
    • NAVERクラウドプラットフォームが自動付与(デフォルト)
    • 3~30文字
    loadBalancerAlgorithmTypeCodeStringOptionalロードバランシングに使用するアルゴリズムタイプ
    • RR(デフォルト) | SIPHS | LC
      • RR: Round Robin
      • SIPHS: Source IP Hash
      • LC: Least Connection
    loadBalancerDescriptionStringOptionalロードバランサの説明(Byte)
    • 0~1,000
    networkUsageTypeCodeStringOptionalロードバランサのネットワークタイプ
    • PBLIP(デフォルト) | PRVT
      • PBLIP (Public): グローバル IPアドレス
      • PRVT (Private): プライベート IPアドレス
    serverInstanceNoList.NStringOptionalロードバランサにバインドするサーバインスタンスの番号リスト
    loadBalancerRuleList.N.protocolTypeCodeStringRequiredロードバランサルールのプロトコルタイプ
    • HTTP | HTTPS | TCP | SSL
    loadBalancerRuleList.N.loadBalancerPortIntegerRequiredロードバランサルールのポート
    • 1~65534
    • 同じロードバランサでポートは重複不可
    • 22、3389、64000、65130、65131、18080~18095ポートはロードバランサ管理用として使用不可
    loadBalancerRuleList.N.serverPortIntegerRequiredロードバランサルールのサーバポート
    • 1~65534
    • 同じロードバランサでポート重複可能
    loadBalancerRuleList.N.l7HealthCheckPathStringConditionalロードバランサルールのヘルスチェックパス
    • /(デフォルト)
    • /で始まる URLパス
    • loadBalancerRuleList.N.protocolTypeCodeHTTPまたはHTTPSの場合、必ず入力
    loadBalancerRuleList.N.certificateNameStringConditionalロードバランサの SSL証明書名
    loadBalancerRuleList.N.protocloTypeCodeSSLまたはHTTPSの場合、必ず入力
    loadBalancerRuleList.N.proxyProtocolUseYnStringOptionalプロキシプロトコルの使用有無
    • Y | N
      • Y: 設定
      • N: 解除
    • loadBalancerRuleList.N.protocloTypeCodeTCPまたはSSLの場合、設定可能
    loadBalancerRuleList.N.stickySessionUseYnStringOptionalセッション別アクセスの使用有無
    • Y | N
      • Y: 設定
      • N: 解除
    • loadBalancerRuleList.N.protocloTypeCodeHTTPまたはHTTPSの場合、設定可能
    loadBalancerRuleList.N.http2UseYnStringOptionalHTTP/2プロトコルの使用有無
    • Y | N
      • Y: 設定
      • N: 解除
    • loadBalancerRuleList.N.protocloTypeCodeHTTPSの場合、設定可能
    loadBalancerRuleList.N.serverProtocolTypeCodeStringOptionalサーバのプロトコルタイプ
    • HTTP(デフォルト) | HTTPS
    • loadBalancerRuleList.N.protocloTypeCode HTTPSの場合、設定可能
    regionNoStringOptionalロードバランサ作成対象のリージョン番号
  • getRegionListを通じて確認
  • リージョンとゾーンの両方を入力しない場合、韓国リージョンのゾーンに任意に割り当て
  • zoneNoListList<String>Optionalロードバランサ作成対象のゾーン番号リスト
    • zoneNogetRegionListを通じて確認
    • プライベート IPアドレスのロードバランサは1つのゾーンのみ選択可能で、マルチゾーンはサポート予定

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/loadbalancer/v2/createLoadBalancerInstance
    ?loadBalancerRuleList.1.l7HealthCheckPath=/
    &loadBalancerRuleList.1.loadBalancerPort=80
    &loadBalancerRuleList.1.protocolTypeCode=HTTP
    &loadBalancerRuleList.1.serverPort=80'
    --header 'x-ncp-apigw-timestamp: {Timestamp}'
    --header 'x-ncp-iam-access-key: {Access Key}'
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

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

    レスポンスボディ

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

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

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

    レスポンス例

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

    <createLoadBalancerInstanceResponse>
        <requestId>1e3eac26-c57e-4c8b-b6b0-ba3fe2330a61</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <loadBalancerInstanceList>
            <loadBalancerInstance>
                <loadBalancerInstanceNo>********</loadBalancerInstanceNo>
                <virtualIp>***.***.***.***,**.***.***.***</virtualIp>
                <loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
                <loadBalancerAlgorithmType>
                    <code>RR</code>
                    <codeName>Round Robin</codeName>
                </loadBalancerAlgorithmType>
                <loadBalancerDescription></loadBalancerDescription>
                <createDate>2024-06-07T19:28:24+0900</createDate>
                <domainName>slb-24784632.ncloudslb.com</domainName>
                <loadBalancerInstanceStatusName>creating</loadBalancerInstanceStatusName>
                <loadBalancerInstanceStatus>
                    <code>INIT</code>
                    <codeName>NET INIT state</codeName>
                </loadBalancerInstanceStatus>
                <loadBalancerInstanceOperation>
                    <code>USE</code>
                    <codeName>NET USE OP</codeName>
                </loadBalancerInstanceOperation>
                <networkUsageType>
                    <code>PBLIP</code>
                    <codeName>Public</codeName>
                </networkUsageType>
                <isHttpKeepAlive>false</isHttpKeepAlive>
                <connectionTimeout>60</connectionTimeout>
                <certificateName></certificateName>
                <region>
                    <regionNo>1</regionNo>
                    <regionCode>KR</regionCode>
                    <regionName>Korea</regionName>
                </region>
                <zoneList>
                    <zone>
                        <zoneNo>2</zoneNo>
                        <zoneName>KR-1</zoneName>
                        <zoneCode>KR-1</zoneCode>
                        <zoneDescription>加山 zone</zoneDescription>
                        <regionNo>1</regionNo>
                    </zone>
                </zoneList>
                <loadBalancerRuleList>
                    <loadBalancerRule>
                        <protocolType>
                            <code>HTTP</code>
                            <codeName>http</codeName>
                        </protocolType>
                        <loadBalancerPort>80</loadBalancerPort>
                        <serverPort>80</serverPort>
                        <l7HealthCheckPath>/</l7HealthCheckPath>
                        <certificateName></certificateName>
                        <proxyProtocolUseYn>N</proxyProtocolUseYn>
                        <stickySessionUseYn>N</stickySessionUseYn>
                        <http2UseYn>N</http2UseYn>
                    </loadBalancerRule>
                </loadBalancerRuleList>
                <loadBalancedServerInstanceList/>
            </loadBalancerInstance>
        </loadBalancerInstanceList>
    </createLoadBalancerInstanceResponse>
    

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

    レスポンスステータスコードの説明は次の通りです。

    HTTPステータスコードコードメッセージ説明
    40010300Instance name is already in use. please use other name.インスタンス名は重複不可
    40010105Unable to create load balancer anymore since contract limitation setting has been exceeded. Number of contract limitation: {0} Number of current contracts : {1}サービス利用限度超過
    40023011We are sorry that {0} cannot be used for load balancer ports since the ports are in use for load balancer management.ロードバランサ管理用として既に使用中のポート
    40023017This version of the load balancer can not create with private IP.プライベート IPアドレスでは作成できないロードバランサ
    40023018Can not create the load balancer.ロードバランサ作成エラー
    40023019There is no resource for the load balancer.ロードバランサにリソースがない
    40024063The number of load balancer settings has been exceeded.ロードバランサ設定限度超過
    40024064The range of usable {0} port is from 1 to 66534.ポート番号は1~66534以内でなければならない
    40024065{0} Duplicated port number. Port number : {1}ポート番号は重複不可
    40024066When setting load balancer, Health Check route must be configured to HTTP protocol.ロードバランサルールのプロトコルタイプが HTTPの場合、ヘルスチェックパスの入力は必須
    40024091No IP address is assigned to the server instance (no. {0}).サーバインスタンスに割り当てグローバル IPアドレスがない
    40024099When setting load balancer, Health Check route must be configured to HTTP or HTTPS protocol.ロードバランサルールのプロトコルタイプが HTTPまたは HTTPSの場合、ヘルスチェックパスの入力は必須
    40024109The input parameter instance number is invalid.無効なインスタンス番号
    40024111The input parameter zone number is invalid.無効なゾーン番号
    40024120The input parameter server instance number is invalid.無効なサーバインスタンス番号
    40024130The input parameter load balancing algorithm is invalid.無効なロードバランシングアルゴリズム
    40024131The field {0} in the load balancer rule parameter is invalid.ロードバランサルールの{0}フィールドが有効ではない
    40024132The field healthCheckPath in the load balancer rule parameter is invalid. If the protocol is HTTP, it is required. it must start with slash('/') and contain no blank.ロードバランサルールのプロトコルタイプが HTTPの場合、ヘルスチェックパスの入力は必須。URLパスは「/」で始まり、スペースは使用不可
    40024133The field healthCheckPath in the load balancer rule parameter is invalid. If the protocol is NOT HTTP, it must not be specified.ロードバランサルールのプロトコルタイプが HTTPではない場合、ヘルスチェックパスは指定不可
    40024134The number of input parameter load balancer rules is the minimum of 1, maximum of 5.文字の長さ制限: 1~5
    40024173Only one zone can be selected for private IP load balancer.プライベート IPアドレスを使用するロードバランサは1つのゾーンだけ入力可能
    40024300The length constraints of the parameter description (memo) were violated. The minimum length is 0 byte, the maximum, 1,000 bytes.説明は1~1,000バイト以内で入力
    40025050(Other)Unable to operate load balancer since use is manipulating the applying server.ロードバランサにサーバを適用中のため、使用不可
    40025051Server is already being applied to load balancer.ロードバランサで既に適用中のサーバ
    40025052Server {0} is unable to apply to load balancer since it is either in operation or not being suspended.サーバが運用中か、停止されていないため、ロードバランサに適用不可
    40026034An error occurred during certificate verification.証明書認証エラー
    40026035Not found memberNo OR certificateName. Please check your input parameter.会員番号または証明書名が見つからない
    40026036Not found memberNo OR certificateName OR privateKey OR publicKeyCertificate. Please check your input parameter.会員番号、証明書名、秘密鍵または公開鍵が見つからない
    40026037Certificate is being used in another loadBalancer.他のロードバランサで既に使用中の証明書
    40026002The issuer certificate of a looked up certificate could not be found. This normally means the list of trusted certificates is not complete.証明書の発行者が見つからない
    40026003The CRL of a certificate could not be found.CRLが見つからない
    40026004The certificate signature could not be decrypted. This means that the actual signature value could not be determined rather than it not matching the expected value, this is only meaningful for RSA keys.証明書署名の復号化に失敗
    40026005The CRL signature could not be decrypted: this means that the actual signature value could not be determined rather than it not matching the expected value. Unused.CRL署名の復号化に失敗
    40026006The public key in the certificate SubjectPublicKeyInfo could not be read.証明書の公開鍵を読み取れない
    40026007The signature of the certificate is invalid.証明書の署名が有効ではない
    40026008The signature of the certificate is invalid.証明書の署名が有効ではない
    40026009The certificate is not yet valid: the notBefore date is after the current time.証明書の有効開始日が本日以降に設定されている
    40026010The certificate has expired: that is the notAfter date is before the current time.証明書の有効期限が本日以前に設定されている
    40026011The CRL is not yet valid.無効な CRL
    40026012The CRL has expired.CRLの有効期限切れ
    40026013The certificate notBefore field contains an invalid time.証明書の有効開始日時が有効ではない
    40026014The certificate notAfter field contains an invalid time.証明書の有効期限が有効ではない
    40026015The CRL lastUpdate field contains an invalid time.CRLの最終更新日時が有効ではない
    40026016The CRL nextUpdate field contains an invalid time.CRLの次の更新日時が有効ではない
    40026017An error occurred trying to allocate memory. This should never happen.メモリ割り当てエラー
    40026018The passed certificate is self signed and the same certificate cannot be found in the list of trusted certificates.自己署名された証明書で、信頼できる証明書リストでは見つからない
    40026019The certificate chain could be built up using the untrusted certificates but the root could not be found locally.ローカルでルート証明書が見つからない
    40026020The issuer certificate could not be found: this occurs if the issuer certificate of an untrusted certificate cannot be found.証明書の発行者が見つからない
    40026021No signatures could be verified because the chain contains only one certificate and it is not self signed.署名認証に失敗
    40026022The certificate chain length is greater than the supplied maximum depth. Unused.証明書チェーンの長さ制限超過
    40026023The certificate has been revoked.証明書が解除される
    40026024A CA certificate is invalid. Either it is not a CA or its extensions are not consistent with the supplied purpose.無効な CA証明書
    40026025The basicConstraints path length parameter has been exceeded.認証パスの長さ制限超過
    40026026The supplied certificate cannot be used for the specified purpose.証明書を当該用途に使用できない
    40026027The root CA is not marked as trusted for the specified purpose.ルート CA証明書を信頼できない
    40026028The root CA is marked to reject the specified purpose.ルート CA証明書リクエストが拒否される
    40026029The current candidate issuer certificate was rejected because its subject name did not match the issuer name of the current certificate. Only displayed when the -issuer_checks option is set.サブジェクト名が発行者名と一致しないため、証明書リクエストが拒否される
    40026030The current candidate issuer certificate was rejected because its subject key identifier was present and did not match the authority key identifier current certificate. Only displayed when the -issuer_checks option is set.サブジェクト鍵識別子が認証局鍵識別子と一致しないため、証明書リクエストが拒否される
    40026031The current candidate issuer certificate was rejected because its issuer name and serial number was present and did not match the authority key identifier of the current certificate. Only displayed when the -issuer_checks option is set.証明書発行者とシリアル番号が認証局鍵識別子と一致しないため、証明書リクエストが拒否される
    40026032The current candidate issuer certificate was rejected because its keyUsage extension does not permit certificate signing.キー用途の拡張が署名を許可しなかったため、証明書リクエストが拒否される
    40026033An application specific error. Unused.アプリケーションエラー
    40026034An error occurred during certificate verification.証明書認証エラー
    40026035Not found memberNo OR certificateName. Please check your input parameter.会員番号または証明書名が見つからない
    40026036Not found memberNo OR certificateName OR privateKey OR publicKeyCertificate. Please check your input parameter.会員番号、証明書名、秘密鍵または公開鍵が見つからない
    40026037Certificate is being used in another loadBalancer.他のロードバランサで既に使用中の証明書
    40026038The certificate name required for SSL/HTTPS. Please check your input parameter.ロードバランサルールのプロトコルタイプが SSLまたは HTTPSの場合、証明書名の入力は必須
    40026042Proxy protocol can be set only with TCP, SSL protocols.ロードバランサルールのプロトコルタイプが TCPまたは SSLの場合にのみプロキシプロトコルを設定可能

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.