computing / Client / nifty_configure_elastic_load_balancer_health_check

nifty_configure_elastic_load_balancer_health_check

computing.Client.nifty_configure_elastic_load_balancer_health_check(**kwargs)

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

マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。

ヘルスチェックパス、およびヘルスチェック期待値を指定するためには、ヘルスチェックプロトコルが「HTTP」もしくは「HTTPS」である必要があります。

設定したマルチロードバランサーのヘルスチェックの内容は、API「 NiftyDescribeElasticLoadBalancers」で確認できます。

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

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_configure_elastic_load_balancer_health_check(
    ElasticLoadBalancerId='string',
    ElasticLoadBalancerName='string',
    ElasticLoadBalancerPort=123,
    HealthCheck={
        'Interval': 123,
        'ListOfRequestExpectation': [
            {
                'HttpCode': 'string'
            },
        ],
        'Path': 'string',
        'Target': 'string',
        'UnhealthyThreshold': 123
    },
    InstancePort=123,
    Protocol='TCP'|'UDP'|'HTTP'|'HTTPS'
)

Parameters:

• ElasticLoadBalancerId (string) –

• ElasticLoadBalancerName (string) –

• ElasticLoadBalancerPort (integer) – [REQUIRED]

• HealthCheck (dict) –

  [REQUIRED]

  • Interval (integer) – [REQUIRED]

  • ListOfRequestExpectation (list) –

    • (dict) –

      • HttpCode (string) –

  • Path (string) –

  • Target (string) – [REQUIRED]

  • UnhealthyThreshold (integer) – [REQUIRED]

• InstancePort (integer) – [REQUIRED]

• Protocol (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'NiftyConfigureElasticLoadBalancerHealthCheckResult': {
        'HealthCheck': {
            'Expectation': [
                {
                    'HttpCode': 'string'
                },
            ],
            'Interval': 123,
            'Path': 'string',
            'Target': 'string',
            'UnhealthyThreshold': 123
        }
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

• (dict) –

  • NiftyConfigureElasticLoadBalancerHealthCheckResult (dict) –

    • HealthCheck (dict) –

      • Expectation (list) –

        • (dict) –

          • HttpCode (string) –

      • Interval (integer) –

      • Path (string) –

      • Target (string) –

      • UnhealthyThreshold (integer) –

  • ResponseMetadata (dict) –

    • RequestId (string) –