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