ConfigureHealthCheck
処理概要
指定したロードバランサーのヘルスチェックの設定を変更します。
ロードバランサーを指定するためには、ロードバランサー名・ポート番号が必要です。削除済みのロードバランサーを指定した、管理外のロードバランサーを指定したなど、無効なロードバランサーを指定した場合は、エラーが返されます。
ヘルスチェックの実行結果は、API「DescribeInstanceHealth」で確認できます。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 |
|---|---|---|---|
| LoadBalancerName |
対象のロードバランサー名 Type : String |
○ | lb0001 |
| LoadBalancerPort |
対象の待ち受けポート Type : Integer |
○ | 80 |
| InstancePort |
対象の宛先ポート Type : Integer |
○ | 80 |
| HealthCheck.Target |
ヘルスチェック プロトコル (TCP指定の場合 「:宛先ポート」) Type : String 値 : TCP:宛先ポート | ICMP |
○ | TCP:80 |
| HealthCheck.Interval |
ヘルスチェック間隔 Type : Integer 単位 : 秒 値 : 5 - 300 |
○ | 300 |
| HealthCheck.Timeout | ※指定不可 Type : Integer |
||
| HealthCheck.UnhealthyThreshold |
ヘルスチェック回数の閾値 ※この回数を超えて連続してチェックに失敗した場合、問題があるものと判断し、該当サーバーをロードバランサーから切り離す。 Type : Integer 値 : 1 - 10 |
○ | 3 |
| HealthCheck.HealthyThreshold | ※指定不可 Type : Integer |
応答フィールド
| フィールド(項目) | 説明 | サンプル値 |
|---|---|---|
| ConfigureHealthCheckResponse | ConfigureHealthCheck レスポンス Type : ConfigureHealthCheckResponse Ancestor : なし Children : ConfigureHealthCheckResult, ResponseMetadata |
|
| ConfigureHealthCheckResult | ヘルスチェック設定の情報セット Type : ConfigureHealthCheckResult Ancestor : ConfigureHealthCheckResponse Children : HealthCheck |
|
| HealthCheck | ヘルスチェック設定の情報 Type : HealthCheck Ancestor : ConfigureHealthCheckResult Children : Target, Interval, Timeout, UnhealthyThreshold, HealthyThreshold |
|
| Target | ヘルスチェック プロトコル Type : xsd:string Ancestor : HealthCheck Children : なし |
TCP:80 |
| Interval |
ヘルスチェック間隔 Type : xsd:integer 単位 :秒 Ancestor : HealthCheck Children : なし |
300 |
| Timeout |
タイムアウト Type : xsd:integer 単位 :秒 Ancestor : HealthCheck Children : なし |
900 |
| UnhealthyThreshold | ヘルスチェック回数の閾値
Ancestor : HealthCheck Children : なし |
3 |
| HealthyThreshold | ヘルスチェックの復旧判断
Ancestor : HealthCheck Children : なし |
1 |
| ResponseMetadata | リクエスト情報 Type : ResponseMetadata Ancestor : ConfigureHealthCheckResponse Children : RequestId |
|
| RequestId | リクエスト識別子 Type : xsd:string Ancestor : ResponseMetadata Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?Action=ConfigureHealthCheck&LoadBalancerName=lb0001
&LoadBalancerPort=80&InstancePort=80&HealthCheck.Target=TCP%3A80&HealthCheck.Interval=300
&HealthCheck.UnhealthyThreshold=3&CommonParams
応答サンプル
<ConfigureHealthCheckResponse xmlns="https://cp.cloud.nifty.com/api/">
<ConfigureHealthCheckResult>
<HealthCheck>
<Target>TCP:80</Target>
<Interval>300</Interval>
<Timeout>900</Timeout>
<UnhealthyThreshold>3</UnhealthyThreshold>
<HealthyThreshold>1</HealthyThreshold>
</HealthCheck>
</ConfigureHealthCheckResult>
<ResponseMetadata>
<RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
</ResponseMetadata>
</ConfigureHealthCheckResponse>
