changeTargetGroupHealthCheckConfiguration
    • PDF

    changeTargetGroupHealthCheckConfiguration

    • PDF

    記事の要約

    VPC環境で利用できます。

    ターゲットグループのヘルスチェック設定を変更します。

    リクエスト

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

    メソッドURI
    GET/changeTargetGroupHealthCheckConfiguration

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    regionCodeStringOptionalヘルスチェック設定変更対象のターゲットグループのリージョン
    • getRegionList照会結果の最初のリージョン(デフォルト)
    • getRegionListを通じて確認
    targetGroupNoStringRequiredターゲットグループの番号
    healthCheckPortIntegerConditionalターゲットの状態を確認するためのヘルスチェック実行時にロードバランサが使用するポート
    • 1~65534 (デフォルト: 80)
    healthCheckUrlPathStringConditionalヘルスチェック実行時に使用する URLパス
    • /で始まる URLパスを入力
    • ターゲットグループのヘルスチェックプロトコルタイプがHTTPまたはHTTPSの場合、変更可能
    healthCheckHttpMethodTypeCodeStringConditionalヘルスチェックに使用する HTTPメソッドタイプ
    • HEAD | GET
    • 選択したターゲットグループのヘルスチェックプロトコルタイプがHTTPまたはHTTPSの場合、変更可能
    healthCheckCycleIntegerConditionalヘルスチェック周期(秒)
    • 5~300
    healthCheckUpThresholdIntegerConditionalターゲットの状態を正常と判断するために必要な連続ヘルスチェック成功回数
    • 2~10
    healthCheckDownThresholdIntegerConditionalターゲットの状態を異常と判断するために必要な連続ヘルスチェック失敗回数
    • 2~10
    responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/changeTargetGroupHealthCheckConfiguration
    ?regionCode=KR
    &targetGroupNo=*******
    &healthCheckPort=80
    &healthCheckUrlPath=/
    &healthCheckHttpMethodTypeCode=GET
    &healthCheckCycle=30
    &healthCheckUpThreshold=2
    &healthCheckDownThreshold=2'
    --header 'x-ncp-apigw-timestamp: {Timestamp}'
    --header 'x-ncp-iam-access-key: {Access Key}'
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

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

    レスポンスボディ

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

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

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

    レスポンス例

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

    <changeTargetGroupHealthCheckConfigurationResponse>
        <requestId>3a30cb81-63af-4565-b38b-55d01c9f777d</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <targetGroupList>
            <targetGroup>
                <targetGroupNo>*******</targetGroupNo>
                <targetGroupName>test-*****</targetGroupName>
                <targetType>
                    <code>VSVR</code>
                    <codeName>Server (VPC)</codeName>
                </targetType>
                <vpcNo>*****</vpcNo>
                <targetGroupProtocolType>
                    <code>HTTP</code>
                    <codeName>HTTP protocol</codeName>
                </targetGroupProtocolType>
                <targetGroupPort>80</targetGroupPort>
                <targetGroupDescription></targetGroupDescription>
                <useStickySession>false</useStickySession>
                <useProxyProtocol>false</useProxyProtocol>
                <algorithmType>
                    <code>RR</code>
                    <codeName>Round Robin</codeName>
                </algorithmType>
                <createDate>2024-06-03T13:30:20+0900</createDate>
                <regionCode>KR</regionCode>
                <loadBalancerInstanceNo></loadBalancerInstanceNo>
                <healthCheckProtocolType>
                    <code>HTTP</code>
                    <codeName>HTTP protocol</codeName>
                </healthCheckProtocolType>
                <healthCheckPort>80</healthCheckPort>
                <healthCheckUrlPath>/</healthCheckUrlPath>
                <healthCheckHttpMethodType>
                    <code>GET</code>
                    <codeName>HTTP GET Method</codeName>
                </healthCheckHttpMethodType>
                <healthCheckCycle>30</healthCheckCycle>
                <healthCheckUpThreshold>2</healthCheckUpThreshold>
                <healthCheckDownThreshold>2</healthCheckDownThreshold>
                <targetNoList/>
            </targetGroup>
        </targetGroupList>
    </changeTargetGroupHealthCheckConfigurationResponse>
    

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

    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.