ニフクラAPI (コンピューティング: NiftyDescribeInstanceElasticLoadBalancerHealth)

NiftyDescribeInstanceElasticLoadBalancerHealth

処理概要

指定したマルチロードバランサーに設定されている、サーバーのヘルスチェック結果を取得します。ヘルスチェックは、API 「NiftyConfigureElasticLoadBalancerHealthCheck」で設定します。
マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。
また、サーバーを指定するためには、サーバー名または、サーバーユニークIDが必要です。サーバーを指定しない場合は、指定したマルチロードバランサーに設定されているすべてのサーバーを対象として、ヘルスチェック結果を取得します。

指定するパラメーター

パラメーター	型	説明	必須
ElasticLoadBalancerId	string	対象のマルチロードバランサーユニークID	○ (マルチロードバランサー名といずれか)
ElasticLoadBalancerName	string	対象のマルチロードバランサー名 使用可能文字: 半角英数字(15文字)	○ (マルチロードバランサーユニークIDといずれか)
Protocol	string	プロトコル 値: TCP UDP HTTP HTTPS	○
ElasticLoadBalancerPort	integer	待ち受けポート 使用可能文字: 1〜65535の数値	○
InstancePort	integer	宛先ポート 使用可能文字: 1〜65535の数値	○
Instances.member.n.InstanceUniqueId	string	サーバーユニークID
Instances.member.n.InstanceId	string	サーバー名

応答フィールド

フィールド (項目)	型	説明
NiftyDescribeInstanceElasticLoadBalancerHealthResponse	-	NiftyDescribeInstanceElasticLoadBalancerHealthレスポンス
␣NiftyDescribeInstanceElasticLoadBalancerHealthResult	-	マルチロードバランサーのヘルスチェック情報
␣␣InstanceStates	-	該当のサーバーのヘルスチェック情報セット
␣␣␣member	-	該当のサーバーのヘルスチェック情報
␣␣␣␣InstanceUniqueId	string	サーバーユニークID
␣␣␣␣InstanceId	string	サーバー名
␣␣␣␣State	string	ヘルスステータス 値: InService OutOfService Unobtainable
␣␣␣␣ReasonCode	string	※空を返却
␣␣␣␣Description	string	※空を返却
␣ResponseMetadata	-	リクエスト情報
␣␣RequestId	string	リクエスト識別子

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyDescribeInstanceElasticLoadBalancerHealth
  &ElasticLoadBalancerName=lb0001
  &Protocol=HTTPS
  &ElasticLoadBalancerPort=443
  &InstancePort=443

  

応答サンプル

    <NiftyDescribeInstanceElasticLoadBalancerHealthResponse xmlns="https://computing.api.nifcloud.com/api/">
  <NiftyDescribeInstanceElasticLoadBalancerHealthResult>
    <InstanceStates>
      <member>
        <InstanceUniqueId>i-a1b2c3d4</InstanceUniqueId>
        <InstanceId>lb0001</InstanceId>
        <State>InService</State>
        <ReasonCode/>
        <Description/>
      </member>
    </InstanceStates>
  </NiftyDescribeInstanceElasticLoadBalancerHealthResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</NiftyDescribeInstanceElasticLoadBalancerHealthResponse>