本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>APIのご利用にあたって>ニフクラREST API>NiftyDescribeInstanceElasticLoadBalancerHealth

NiftyDescribeInstanceElasticLoadBalancerHealth

処理概要

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
ElasticLoadBalancerId 対象のマルチロードバランサーユニークID
Type : String

(マルチロードバランサー名といずれか)
elb-8db04f81
ElasticLoadBalancerName 対象のマルチロードバランサー名
Type : String
使用可能文字 : 半角英数字(15文字)

(マルチロードバランサーユニークIDといずれか)
 
Protocol プロトコル
Type : String
値 : TCP | UDP | HTTP | HTTPS
 
ElasticLoadBalancerPort 待ち受けポート
Type : Integer
値 : 1〜65535の数値
 
InstancePort 宛先ポート
Type : Integer
値 : 1〜65535の数値
 
Instances.member.n.InstanceUniqueId サーバーユニークID
Type : String
  i-a1b2c3d4
Instances.member.n.InstanceId サーバー名
Type : String
  server02

応答フィールド

フィールド 説明 サンプル値
NiftyDescribeInstanceElasticLoadBalancerHealthResponse NiftyDescribeInstanceElasticLoadBalancerHealthレスポンス
Type : NiftyDescribeInstanceElasticLoadBalancerHealthResponse
Ancestor : なし
Children : NiftyDescribeInstanceElasticLoadBalancerResult,ResponseMetadata
 
NiftyDescribeInstanceElasticLoadBalancerHealthResult マルチロードバランサーのヘルスチェック情報
Type : NiftyDescribeInstanceElasticLoadBalancerHealthResult
Ancestor : NiftyDescribeInstanceElasticLoadBalancerHealthResponse
Children : InstanceStates、ResponseMetadata
 
InstanceStates 該当のサーバーのヘルスチェック情報セット
Type : InstanceStates
Ancestor : NiftyDescribeInstanceElasticLoadBalancerHealthResult
Children : member
 
member 該当のサーバーのヘルスチェック情報
Type : member
Ancestor : InstanceStates
Children : InstanceState
 
InstanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : member
Children : なし
 
InstanceId サーバー名
Type : xsd:string
Ancestor : member
Children : なし
 
State ヘルスステータス
Type : xsd:string
値 : InService | OutOfService
Ancestor : member
Children : なし
 
ReasonCode ※空を返却
Type : xsd:string
Ancestor : member
Children : なし
 
Description ※空を返却
Type : xsd:string
Ancestor : member
Children : なし
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : NiftyDescribeInstanceElasticLoadBalancerHealthResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor :ResponseMetadata
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyDescribeInstanceElasticLoadBalancerHealth&ElasticLoadBalancerName=lb0001&Protocol=TCP&ElasticLoadBalancerPort=443&InstancePort=443

応答サンプル

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

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

APIメニュー

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

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