本文へジャンプします。

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

nifty-describe-instance-health

処理概要

API「DescribeInstanceHealth」が実行されます。

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

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

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

コマンド構文

nifty-describe-instance-health ロードバランサー名 [オプション]

オプション

オプション 短縮 説明 必須
--instances VALUE1 [,VALUE2,... ]   ヘルスチェックの対象サーバーを指定します。
(自分が所有していないサーバーを指定する場合は、「@nifty法人ID.サーバー名」を指定します。)
 
--lb-port LBPORT   待ち受けポート番号を指定します。
--instance-port INSTANCEPORT   宛先ポート番号を指定します。

出力要素

※ニフティクラウドAPIの応答フィールド名を記述します。

  • INSTANCE_ID / instanceId
  • INSTANCE_ID / State
  • INSTANCE_ID / CreatedTime

実行サンプル

PROMPT>nifty-describe-instance-health lb01 --instances server01,zyp00123.server02  --lb-port 443 --instance-port 443
INSTANCE_ID  server01  InService
INSTANCE_ID  zyp00123.server02  OutOfService

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

APIメニュー

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

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