nifty-configure-healthcheck
処理概要
API「ConfigureHealthCheck」が実行されます。
指定したロードバランサーのヘルスチェックの設定を変更します。
ロードバランサーを指定するためには、ロードバランサー名・ポート番号が必要です。削除済みのロードバランサーを指定した、管理外のロードバランサーを指定したなど、無効なロードバランサーを指定した場合は、エラーが返されます。
ヘルスチェックの実行結果は、API「DescribeInstanceHealth」で確認できます。
コマンド構文
nifty-configure-healthcheck ロードバランサー名 [オプション]
オプション
オプション | 短縮 | 説明 | 必須 |
---|---|---|---|
--healthy-threshold VALUE | サーバーが正常復帰したと判断するへルスチェックの回数を指定します。 | ||
--interval VALUE | ヘルスチェックを行う間隔を指定します。(単位 秒) | ○ | |
--target VALUE | -t |
ヘルスチェックを行うプロトコルと宛先ポートを指定します。 “プロトコル(TCP/ICMP):宛先ポート“ |
○ |
--unhealthy-threshold VALUE | タイムアウトまでのヘルスチェック回数を指定します。 ※サーバーを切り離すタイムアウト時間の算出で利用します。 |
○ | |
--lb-port LBPORT | 待ち受けポート番号を指定します。 | ○ | |
--instance-port INSTANCEPORT | 宛先ポート番号を指定します。 | ○ |
出力要素
※ニフクラAPIの応答フィールド名を記述します。
- HEALTH_CHECK / Target
- HEALTH_CHECK / Interval
- HEALTH_CHECK / HealthyThreshold
- HEALTH_CHECK / Timeout
- HEALTH_CHECK / UnhealthyThreshold
実行サンプル
PROMPT>nifty-configure-healthcheck lb01 --healthy-threshold 1 --interval 300 --target TCP:80 --unhealthy-threshold 3 --lb-port 443 --instance-port 443
HEALTH_CHECK TCP:80 300 1 30 3