changeLoadBalancerInstanceConfiguration

Prev Next

Classic環境で利用できます。

ロードバランサインスタンスルールの設定を変更します。

リクエスト

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

メソッド URI
GET /changeLoadBalancerInstanceConfiguration

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
loadBalancerInstanceNo String Required 設定変更対象のロードバランサインスタンスの番号
loadBalancerAlgorithmTypeCode String Required ロードバランシングに使用するアルゴリズムタイプ
  • RR | LC
    • RR: Round Robin
    • LC: Least Connection
loadBalancerDescription String Optional ロードバランサの説明(Byte)
  • 0~1,000
loadBalancerRuleList.N.protocolTypeCode String Required ロードバランサルールのプロトコルタイプ
  • HTTP | HTTPS | TCP
loadBalancerRuleList.N.loadBalancerPort Integer Required ロードバランサルールのポート
  • 1~65534
  • 同じロードバランサでポートは重複不可
  • 22、3389、64000、65130、65131、18080~18095ポートはロードバランサ管理用として使用不可
loadBalancerRuleList.N.serverPort Integer Required ロードバランサルールのサーバポート
  • 1~65534
  • 同じロードバランサでポート重複可能
loadBalancerRuleList.N.l7HealthCheckPath String Conditional ロードバランサルールのヘルスチェックパス
  • /(デフォルト)
  • /で始まる URLパス
  • loadBalancerRuleList.N.protocolTypeCodeHTTPまたはHTTPSの場合、必ず入力
loadBalancerRuleList.N.certificateName String Conditional ロードバランサの SSL証明書名
  • loadBalancerRuleList.N.protocloTypeCodeSSLまたはHTTPSの場合、必ず入力
loadBalancerRuleList.N.proxyProtocolUseYn String Optional プロキシプロトコルの使用有無
  • Y | N
    • Y: 設定
    • N: 解除
  • loadBalancerRuleList.N.protocloTypeCodeTCPまたはSSLの場合、設定可能
loadBalancerRuleList.N.stickySessionUseYn String Optional セッション別アクセスの使用有無
  • Y | N
    • Y: 設定
    • N: 解除
  • loadBalancerRuleList.N.protocloTypeCodeHTTPまたはHTTPSの場合、設定可能
loadBalancerRuleList.N.http2UseYn String Optional HTTP/2プロトコルの使用有無
  • Y | N
    • Y: 設定
    • N: 解除
  • loadBalancerRuleList.N.protocloTypeCodeHTTPSの場合、設定可能
loadBalancerRuleList.N.serverProtocolTypeCode String Optional サーバのプロトコルタイプ
  • HTTP(デフォルト) | HTTPS
  • loadBalancerRuleList.N.protocloTypeCode HTTPSの場合、設定可能
zoneNoList List<String> Optional ロードバランサのゾーンを変更する対象のゾーン番号リスト
  • zoneNogetRegionListを通じて確認
  • ゾーンを変更するとロードバランサ IPアドレスが変更される
  • プライベート IPアドレスのロードバランサはゾーン変更不可、マルチゾーンをサポート予定

リクエスト例

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

curl --location 'https://ncloud.apigw.ntruss.com/loadbalancer/v2/changeLoadBalancerInstanceConfiguration
?loadBalancerInstanceNo=*******
&loadBalancerAlgorithmTypeCode=RR
&loadBalancerRuleList.1.l7HealthCheckPath=/
&loadBalancerRuleList.1.loadBalancerPort=88
&loadBalancerRuleList.1.serverPort=88
&loadBalancerRuleList.1.protocolTypeCode=HTTP'
--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のレスポンスステータスコードをご参照ください。

レスポンス例

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

<changeLoadBalancerInstanceConfigurationResponse>
    <requestId>cdb87e60-2bf1-4438-8d55-470c9f17521c</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-07T18:46:01+0900</createDate>
            <domainName>***.com</domainName>
            <loadBalancerInstanceStatusName>changing</loadBalancerInstanceStatusName>
            <loadBalancerInstanceStatus>
                <code>USED</code>
                <codeName>NET USED state</codeName>
            </loadBalancerInstanceStatus>
            <loadBalancerInstanceOperation>
                <code>CHANG</code>
                <codeName>NET CHANGE 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>
                <zone>
                    <zoneNo>3</zoneNo>
                    <zoneName>KR-2</zoneName>
                    <zoneCode>KR-2</zoneCode>
                    <zoneDescription>坪村 zone</zoneDescription>
                    <regionNo>1</regionNo>
                </zone>
            </zoneList>
            <loadBalancerRuleList>
                <loadBalancerRule>
                    <protocolType>
                        <code>HTTP</code>
                        <codeName>http</codeName>
                    </protocolType>
                    <loadBalancerPort>88</loadBalancerPort>
                    <serverPort>88</serverPort>
                    <l7HealthCheckPath>/</l7HealthCheckPath>
                    <certificateName></certificateName>
                    <proxyProtocolUseYn>N</proxyProtocolUseYn>
                    <stickySessionUseYn>N</stickySessionUseYn>
                    <http2UseYn>N</http2UseYn>
                </loadBalancerRule>
            </loadBalancerRuleList>
            <loadBalancedServerInstanceList>
                <loadBalancedServerInstance>
                    <serverInstance>
                        <serverInstanceNo>********</serverInstanceNo>
                        <serverName>YOUR_SERVER</serverName>
                        <serverDescription></serverDescription>
                        <cpuCount>2</cpuCount>
                        <memorySize>4294967296</memorySize>
                        <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                        <platformType>
                            <code>UBS64</code>
                            <codeName>Ubuntu Server 64 Bit</codeName>
                        </platformType>
                        <loginKeyName>YOUR_LOGIN_KEY</loginKeyName>
                        <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                        <publicIp></publicIp>
                        <privateIp>**.**.***.***</privateIp>
                        <serverImageName>ubuntu-18.04</serverImageName>
                        <serverInstanceStatus>
                            <code>RUN</code>
                            <codeName>Server run state</codeName>
                        </serverInstanceStatus>
                        <serverInstanceOperation>
                            <code>NULL</code>
                            <codeName>Server NULL OP</codeName>
                        </serverInstanceOperation>
                        <serverInstanceStatusName>running</serverInstanceStatusName>
                        <createDate>2024-06-07T18:28:41+0900</createDate>
                        <uptime>2024-06-07T18:35:09+0900</uptime>
                        <serverImageProductCode>SPSW0LINUX000130</serverImageProductCode>
                        <serverProductCode>SPSVRSSD00000003</serverProductCode>
                        <isProtectServerTermination>false</isProtectServerTermination>
                        <portForwardingPublicIp>***.***.***.***</portForwardingPublicIp>
                        <zone>
                            <zoneNo>2</zoneNo>
                            <zoneName>KR-1</zoneName>
                            <zoneCode>KR-1</zoneCode>
                            <zoneDescription>加山 zone</zoneDescription>
                            <regionNo>1</regionNo>
                        </zone>
                        <region>
                            <regionNo>1</regionNo>
                            <regionCode>KR</regionCode>
                            <regionName>Korea</regionName>
                        </region>
                        <baseBlockStorageDiskType>
                            <code>NET</code>
                            <codeName>Network Storage</codeName>
                        </baseBlockStorageDiskType>
                        <baseBlockStorageDiskDetailType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </baseBlockStorageDiskDetailType>
                        <serverInstanceType>
                            <code>STAND</code>
                            <codeName>Standard</codeName>
                        </serverInstanceType>
                        <userData></userData>
                        <initScriptNo></initScriptNo>
                        <accessControlGroupList>
                            <accessControlGroup>
                                <accessControlGroupConfigurationNo>******</accessControlGroupConfigurationNo>
                                <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                                <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                                <isDefault>true</isDefault>
                                <createDate>2021-06-22T18:09:57+0900</createDate>
                            </accessControlGroup>
                        </accessControlGroupList>
                        <instanceTagList/>
                    </serverInstance>
                    <serverHealthCheckStatusList>
                        <serverHealthCheckStatus>
                            <protocolType>
                                <code>HTTP</code>
                                <codeName>http</codeName>
                            </protocolType>
                            <loadBalancerPort>88</loadBalancerPort>
                            <serverPort>88</serverPort>
                            <l7HealthCheckPath>/</l7HealthCheckPath>
                            <proxyProtocolUseYn>N</proxyProtocolUseYn>
                            <serverStatus>false</serverStatus>
                        </serverHealthCheckStatus>
                    </serverHealthCheckStatusList>
                </loadBalancedServerInstance>
            </loadBalancedServerInstanceList>
        </loadBalancerInstance>
    </loadBalancerInstanceList>
</changeLoadBalancerInstanceConfigurationResponse>

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

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

HTTPステータスコード コード メッセージ 説明
400 23011 We are sorry that {0} cannot be used for load balancer ports since the ports are in use for load balancer management. ロードバランサ管理用として既に使用中のポート
400 24063 The number of load balancer settings has been exceeded. ロードバランサ設定限度超過
400 24064 The range of usable {0} port is from 1 to 66534. ポート番号は1~66534以内でなければならない
400 24065 {0} Duplicated port number. Port number : {1} ポート番号は重複不可
400 24066 When setting load balancer, Health Check route must be configured to HTTP protocol. ロードバランサルールのプロトコルタイプが HTTPの場合、ヘルスチェックパスの入力は必須
400 24099 When setting load balancer, Health Check route must be configured to HTTP or HTTPS protocol. ロードバランサルールのプロトコルタイプが HTTPまたは HTTPSの場合、ヘルスチェックパスの入力は必須
400 24109 The input parameter instance number is invalid. 無効なインスタンス番号
400 24111 The input parameter zone number is invalid. 無効なゾーン番号
400 24123 The input parameter load balancer instance number is invalid. 無効なロードバランサインスタンス番号
400 24130 The input parameter load balancing algorithm is invalid. 無効なロードバランシングアルゴリズム
400 24131 The field {0} in the load balancer rule parameter is invalid. ロードバランサルールの{0}フィールドが有効ではない
400 24132 The 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パスは「/」で始まり、スペースは使用不可
400 24133 The field healthCheckPath in the load balancer rule parameter is invalid. If the protocol is NOT HTTP, it must not be specified. ロードバランサルールのプロトコルタイプが HTTPではない場合、ヘルスチェックパスは指定不可
400 24134 The number of input parameter load balancer rules is the minimum of 1, maximum of 5. 文字の長さ制限: 1~5
400 24174 Can not change zone for private IP load balancer. プライベート IPアドレスを使用するロードバランサのゾーンは変更不可
400 25027 You may not change since (other) user is operating the target load balancer. 他のユーザーが対象のロードバランサを運用中のため、変更不可
400 25050 (Other)Unable to operate load balancer since use is manipulating the applying server. ロードバランサにサーバを適用中のため、使用不可
400 26002 The issuer certificate of a looked up certificate could not be found. This normally means the list of trusted certificates is not complete. 証明書の発行者が見つからない
400 26003 The CRL of a certificate could not be found. CRLが見つからない
400 26004 The 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. 証明書署名の復号化に失敗
400 26005 The 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署名の復号化に失敗
400 26006 The public key in the certificate SubjectPublicKeyInfo could not be read. 証明書の公開鍵を読み取れない
400 26007 The signature of the certificate is invalid. 証明書の署名が有効ではない
400 26008 The signature of the certificate is invalid. 証明書の署名が有効ではない
400 26009 The certificate is not yet valid: the notBefore date is after the current time. 証明書の有効開始日が本日以降に設定されている
400 26010 The certificate has expired: that is the notAfter date is before the current time. 証明書の有効期限が本日以前に設定されている
400 26011 The CRL is not yet valid. 無効な CRL
400 26012 The CRL has expired. CRLの有効期限切れ
400 26013 The certificate notBefore field contains an invalid time. 証明書の有効開始日時が有効ではない
400 26014 The certificate notAfter field contains an invalid time. 証明書の有効期限が有効ではない
400 26015 The CRL lastUpdate field contains an invalid time. CRLの最終更新日時が有効ではない
400 26016 The CRL nextUpdate field contains an invalid time. CRLの次の更新日時が有効ではない
400 26017 An error occurred trying to allocate memory. This should never happen. メモリ割り当てエラー
400 26018 The passed certificate is self signed and the same certificate cannot be found in the list of trusted certificates. 自己署名された証明書で、信頼できる証明書リストでは見つからない
400 26019 The certificate chain could be built up using the untrusted certificates but the root could not be found locally. ローカルでルート証明書が見つからない
400 26020 The issuer certificate could not be found: this occurs if the issuer certificate of an untrusted certificate cannot be found. 証明書の発行者が見つからない
400 26021 No signatures could be verified because the chain contains only one certificate and it is not self signed. 署名認証に失敗
400 26022 The certificate chain length is greater than the supplied maximum depth. Unused. 証明書チェーンの長さ制限超過
400 26023 The certificate has been revoked. 証明書が解除される
400 26024 A CA certificate is invalid. Either it is not a CA or its extensions are not consistent with the supplied purpose. 無効な CA証明書
400 26025 The basicConstraints path length parameter has been exceeded. 認証パスの長さ制限超過
400 26026 The supplied certificate cannot be used for the specified purpose. 証明書を当該用途に使用できない
400 26027 The root CA is not marked as trusted for the specified purpose. ルート CA証明書を信頼できない
400 26028 The root CA is marked to reject the specified purpose. ルート CA証明書リクエストが拒否される
400 26029 The 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. サブジェクト名が発行者名と一致しないため、証明書リクエストが拒否される
400 26030 The 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. サブジェクト鍵識別子が認証局鍵識別子と一致しないため、証明書リクエストが拒否される
400 26031 The 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. 証明書発行者とシリアル番号が認証局鍵識別子と一致しないため、証明書リクエストが拒否される
400 26032 The current candidate issuer certificate was rejected because its keyUsage extension does not permit certificate signing. キー用途の拡張が署名を許可しなかったため、証明書リクエストが拒否される
400 26033 An application specific error. Unused. アプリケーションエラー
400 26034 An error occurred during certificate verification. 証明書認証エラー
400 26035 Not found memberNo OR certificateName. Please check your input parameter. 会員番号または証明書名が見つからない
400 26036 Not found memberNo OR certificateName OR privateKey OR publicKeyCertificate. Please check your input parameter. 会員番号、証明書名、秘密鍵または公開鍵が見つからない
400 26037 Certificate is being used in another loadBalancer. 他のロードバランサで既に使用中の証明書
400 26038 The certificate name required for SSL/HTTPS. Please check your input parameter. ロードバランサルールのプロトコルタイプが SSLまたは HTTPSの場合、証明書名の入力は必須
400 26042 Proxy protocol can be set only with TCP, SSL protocols. ロードバランサルールのプロトコルタイプが TCPまたは SSLの場合にのみプロキシプロトコルを設定可能