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

DescribeInstanceHealth

処理概要

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

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

またサーバーを指定するためには、サーバー名が必要です。自分が所有していないサーバーを指定する場合は、「ニフクラID.サーバー名」の形式で指定する必要があります。サーバーを指定しない場合は、指定したロードバランサーに設定されているすべてのサーバーを対象として、ヘルスチェック結果を取得します。

指定するパラメーター

パラメーター	型	説明	必須
LoadBalancerName	string	対象のロードバランサー名	○
LoadBalancerPort	integer	対象の待ち受けポート	○
InstancePort	integer	対象の宛先ポート	○
Instances.member.n.InstanceId	string	対象のサーバー名 Default: 該当ロードバランサーに設定しているすべてのサーバー情報

応答フィールド

フィールド (項目)	型	説明
DescribeInstanceHealthResponse	-	DescribeInstanceHealth レスポンス
␣DescribeInstanceHealthResult	-	DescribeInstanceHealth 結果セット
␣␣InstanceStates	-	該当のサーバー情報セット
␣␣␣member	-	該当のサーバー情報
␣␣␣␣InstanceId	string	サーバー名
␣␣␣␣InstanceUniqueId	string	サーバーユニークID
␣␣␣␣State	string	ヘルスステータス 値: InService (正常) OutOfService (応答なし)
␣␣␣␣ReasonCode	string	※空を返却
␣␣␣␣Description	string	※空を返却
␣ResponseMetadata	-	リクエスト情報
␣␣RequestId	string	リクエスト識別子

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeInstanceHealth
  &LoadBalancerName=lb0001
  &LoadBalancerPort=80
  &InstancePort=80
  &Instances.member.1.InstanceId=server02
  &Instances.member.2.InstanceId=server06
  &CommonParams

  

応答サンプル

    <DescribeInstanceHealthResponse xmlns="https://computing.api.nifcloud.com/api/">
  <DescribeInstanceHealthResult>
    <InstanceStates>
      <member>
        <InstanceId>server02</InstanceId>
        <InstanceUniqueId>i-adgf1234</InstanceUniqueId>
        <State>InService</State>
        <ReasonCode/>
        <Description/>
      </member>
      <member>
        <InstanceId>server06</InstanceId>
        <InstanceUniqueId>i-adgf6789</InstanceUniqueId>
        <State>OutOfService</State>
        <ReasonCode/>
        <Description/>
      </member>
    </InstanceStates>
  </DescribeInstanceHealthResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</DescribeInstanceHealthResponse>