NiftyConfigureElasticLoadBalancerHealthCheck
処理概要
指定したマルチロードバランサーのヘルスチェックの設定を変更します。
マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。
ヘルスチェックパス、およびヘルスチェック期待値を指定するためには、ヘルスチェックプロトコルが「HTTP」もしくは「HTTPS」である必要があります。
設定したマルチロードバランサーのヘルスチェックの内容は、API「NiftyDescribeElasticLoadBalancers」で確認できます。
ヘルスチェックの実行結果は、API「NiftyDescribeInstanceElasticLoadBalancerHealth」で確認できます。
指定するパラメーター
| パラメーター | 型 | 説明 | 必須 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| ElasticLoadBalancerId | string |
対象のマルチロードバランサーユニークID |
○ (マルチロードバランサー名といずれか) | ||||||
| ElasticLoadBalancerName | string |
対象のマルチロードバランサー名 使用可能文字: 半角英数字(15文字) |
○ (マルチロードバランサーユニークIDといずれか) | ||||||
| Protocol | string |
プロトコル 値:
|
○ | ||||||
| ElasticLoadBalancerPort | integer |
待ち受けポート 使用可能文字: 1〜65535の数値 |
○ | ||||||
| InstancePort | integer |
宛先ポート 使用可能文字: 1〜65535の数値 |
○ | ||||||
| HealthCheck.Target | string |
ヘルスチェック プロトコル (TCP/HTTP/HTTPS指定の場合 「:宛先ポート」) 使用可能文字: TCP:宛先ポート(数字 1-65535) | HTTP:宛先ポート(数字 1-65535) | HTTPS:宛先ポート(数字 1-65535) | ICMP |
○ | ||||||
| HealthCheck.Interval | integer |
ヘルスチェック間隔(秒) 単位: 秒 Default: 5 使用可能文字: 5-300 |
○ | ||||||
| HealthCheck.UnhealthyThreshold | integer |
ヘルスチェック回数閾値 ※この回数を超えて連続してチェックに失敗した場合、問題があるものと判断し、該当サーバーをロードバランサーから切り離す。 Default: 1 使用可能文字: 1-10 |
○ | ||||||
| HealthCheck.Path | string |
ヘルスチェックパス 1.指定されたHealthCheck.Targetが「HTTP」もしくは「HTTPS」の場合に有効 2.先頭が”/”で始まっていること 使用可能文字: ASCII(255文字) |
|||||||
| HealthCheck.Expectation.member.n.HttpCode | string |
ヘルスチェック期待値
|
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| NiftyConfigureElasticLoadBalancerHealthCheckResponse | - |
NiftyConfigureElasticLoadBalancerHealthCheckレスポンス |
| ␣NiftyConfigureElasticLoadBalancerHealthCheckResult | - |
ヘルスチェック設定の情報 |
| ␣␣HealthCheck | - |
ヘルスチェックの設定情報 |
| ␣␣␣Target | string |
ヘルスチェック プロトコル |
| ␣␣␣Interval | integer |
ヘルスチェック間隔(秒) |
| ␣␣␣UnhealthyThreshold | integer |
ヘルスチェック回数閾値 |
| ␣␣␣Path | string |
ヘルスチェックパス(CDATA付) |
| ␣␣␣Expectation | - |
ヘルスチェック期待値セット |
| ␣␣␣␣member | - |
ヘルスチェック期待値情報 |
| ␣␣␣␣␣HttpCode | string |
ヘルスチェック期待値 |
| ␣ResponseMetadata | - |
リクエスト情報 |
| ␣␣RequestId | string |
リクエスト識別子 |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=NiftyConfigureElasticLoadBalancerHealthCheck
&ElasticLoadBalancerName=lb0001
&Protocol=HTTP
&ElasticLoadBalancerPort=80
&InstancePort=80
&HealthCheck.Target=HTTP:80
&HealthCheck.Interval=300
&HealthCheck.UnhealthyThreshold=3
&HealthCheck.Path=/
&HealthCheck.Expectation.member.1.HttpCode=2xx
応答サンプル
<NiftyConfigureElasticLoadBalancerHealthCheckResponse xmlns="https://computing.api.nifcloud.com/api/">
<NiftyConfigureElasticLoadBalancerHealthCheckResult>
<HealthCheck>
<Target>HTTP:80</Target>
<Interval>300</Interval>
<UnhealthyThreshold>3</UnhealthyThreshold>
<Path><![CDATA[/]]></Path>
<Expectation>
<member>
<HttpCode>2xx</HttpCode>
</member>
</Expectation>
</HealthCheck>
</NiftyConfigureElasticLoadBalancerHealthCheckResult>
<ResponseMetadata>
<RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
</ResponseMetadata>
</NiftyConfigureElasticLoadBalancerHealthCheckResponse>
