computing / Client / configure_health_check

configure_health_check

computing.Client.configure_health_check(**kwargs)

指定したロードバランサーのヘルスチェックの設定を変更します。

ロードバランサーを指定するためには、ロードバランサー名・ポート番号が必要です。

ヘルスチェックの実行結果は、API「DescribeInstanceHealth」で確認できます。

ヘルスチェックの際のサーバー切り離し時間について

• サーバーからの応答時間がタイムアウトを超えた場合にサーバーをロードバランサーから切り離します。

• 設定されるヘルスチェックのタイムアウト時間については、 `ロードバランサー（L4）のヘルスチェックについて <https://docs.nifcloud.com/network/spec/lb/index.htm#lb_healthcheck>`__をご確認ください。

• 設定されたヘルスチェックのタイムアウト時間は、「DescribeLoadBalancers」の Timeout で確認ができます。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.configure_health_check(
    HealthCheck={
        'HealthyThreshold': 123,
        'Interval': 123,
        'Target': 'string',
        'Timeout': 123,
        'UnhealthyThreshold': 123
    },
    InstancePort=123,
    LoadBalancerName='string',
    LoadBalancerPort=123
)

Parameters:

• HealthCheck (dict) –

  [REQUIRED]

  • HealthyThreshold (integer) –

  • Interval (integer) – [REQUIRED]

  • Target (string) – [REQUIRED]

  • Timeout (integer) –

  • UnhealthyThreshold (integer) – [REQUIRED]

• InstancePort (integer) – [REQUIRED]

• LoadBalancerName (string) – [REQUIRED]

• LoadBalancerPort (integer) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'ConfigureHealthCheckResult': {
        'HealthCheck': {
            'HealthyThreshold': 123,
            'Interval': 123,
            'Target': 'string',
            'UnhealthyThreshold': 123
        }
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

• (dict) –

  • ConfigureHealthCheckResult (dict) –

    • HealthCheck (dict) –

      • HealthyThreshold (integer) –

      • Interval (integer) –

      • Target (string) –

      • UnhealthyThreshold (integer) –

  • ResponseMetadata (dict) –

    • RequestId (string) –