changeLoadBalancerInstanceConfiguration

Prev Next

Classic環境で利用できます。

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

リクエスト

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

メソッド URI
GET /loadbalancer/v2/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をご参照ください。

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

Load Balancer APIで共通して使用されるレスポンスステータスコードの詳細は、Load Balancerのレスポンスステータスコードをご参照ください。

レスポンス例

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

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