本文へジャンプします。

ニフティクラウド APIリファレンス

DescribeInstanceHealth

処理概要

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

ロードバランサーを指定するためには、ロードバランサー名が必要です。削除済みのロードバランサーを指定した、管理外のロードバランサーを指定したなど、無効なロードバランサーを指定した場合は、エラーが返されます。

またサーバーを指定するためには、サーバー名が必要です。自分が所有していないサーバーを指定する場合は、「@nifty法人ID.サーバー名」の形式で指定する必要があります。サーバーを指定しない場合は、指定したロードバランサーに設定されているすべてのサーバーを対象として、ヘルスチェック結果を取得します。削除済みのサーバーを指定した、管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。

指定するパラメーター

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

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeInstanceHealth
Response
DescribeInstanceHealth レスポンス
Type : DescribeInstanceHealthResponse
Ancestor : なし
Children : DescribeInstanceHealthResult, ResponseMetadata
 
DescribeInstanceHealth
Result
DescribeInstanceHealth 結果セット
Type : DescribeInstanceHealthResult
Ancestor : DescribeInstanceHealthResponse
Children : InstanceStates
 
InstanceStates 該当のサーバー情報セット
Type : InstanceStates
Ancestor : DescribeInstanceHealthResult
Children : member
 
member 該当のサーバー情報
Type : InstanceState
Ancestor : InstanceStates
Children : InstanceId, InstanceUniqueId, State, ReasonCode, Description
 
InstanceId サーバー名
Type : xs:string
Ancestor : member
Children : なし
server02
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : member
Children : なし
i-adgf6789
State ヘルスステータス
Type : xs:string
値: InService (正常) | OutOfService (応答なし)
Ancestor : member
Children : なし
InService
ReasonCode ※空を返却
Type : xs:string
Ancestor : member
Children : なし
 
Description ※空を返却
Type : xs:string
Ancestor : member
Children : なし
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : DescribeInstanceHealthResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor : ResponseMetadata
Children : なし
f6dd8353-eb6b-6b4fd32e4f05

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeInstanceHealth&LoadBalancerName=lb0001
&LoadBalancerPort=80&InstancePort=80&CommonParams

応答サンプル

<DescribeInstanceHealthResponse xmlns="https://cp.cloud.nifty.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>f6dd8353-eb6b-6b4fd32e4f05</RequestId>
 </ResponseMetadata>
</DescribeInstanceHealthResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上