computing / Client / nifty_describe_instance_elastic_load_balancer_health

nifty_describe_instance_elastic_load_balancer_health

computing.Client.nifty_describe_instance_elastic_load_balancer_health(**kwargs)

指定したマルチロードバランサーに設定されている、サーバーのヘルスチェック結果を取得します。ヘルスチェックは、API 「 NiftyConfigureElasticLoadBalancerHealthCheck」で設定します。

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

また、サーバーを指定するためには、サーバー名または、サーバーユニークIDが必要です。サーバーを指定しない場合は、指定したマルチロードバランサーに設定されているすべてのサーバーを対象として、ヘルスチェック結果を取得します。

Request Syntax

response = client.nifty_describe_instance_elastic_load_balancer_health(
    ElasticLoadBalancerId='string',
    ElasticLoadBalancerName='string',
    ElasticLoadBalancerPort=123,
    InstancePort=123,
    Instances=[
        {
            'InstanceId': 'string',
            'InstanceUniqueId': 'string'
        },
    ],
    Protocol='TCP'|'UDP'|'HTTP'|'HTTPS'
)

Parameters:

ElasticLoadBalancerId (string) –
ElasticLoadBalancerName (string) –
ElasticLoadBalancerPort (integer) – [REQUIRED]
InstancePort (integer) – [REQUIRED]
Instances (list) –
- (dict) –
  - InstanceId (string) –
  - InstanceUniqueId (string) –
Protocol (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'NiftyDescribeInstanceElasticLoadBalancerHealthResult': {
        'InstanceStates': [
            {
                'Description': 'string',
                'InstanceId': 'string',
                'InstanceUniqueId': 'string',
                'ReasonCode': 'string',
                'State': 'string'
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- NiftyDescribeInstanceElasticLoadBalancerHealthResult (dict) –
  - InstanceStates (list) –
    - (dict) –
      - Description (string) –
      - InstanceId (string) –
      - InstanceUniqueId (string) –
      - ReasonCode (string) –
      - State (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –