本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>APIのご利用にあたって>ニフクラREST API>NiftyConfigureElasticLoadBalancerHealthCheck

NiftyConfigureElasticLoadBalancerHealthCheck

処理概要

指定したマルチロードバランサーのヘルスチェックの設定を変更します。
マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。削除済みのマルチロードバランサーを指定した、管理外のマルチロードバランサーを指定したなど、無効なマルチロードバランサーを指定した場合は、エラーが返されます。
ヘルスチェックパス、およびヘルスチェック期待値を指定するためには、ヘルスチェックプロトコルが「HTTP」もしくは「HTTPS」である必要があります。
設定したマルチロードバランサーのヘルスチェックの内容は、API「NiftyDescribeElasticLoadBalancers」で確認できます。

ヘルスチェックの実行結果は、API「NiftyDescribeInstanceElasticLoadBalancerHealth」で確認できます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
ElasticLoadBalancerId 対象のマルチロードバランサーユニークID
Type : String

(マルチロードバランサー名といずれか)
elb-8db04f81
ElasticLoadBalancerName 対象のマルチロードバランサー名
Type : String
使用可能文字:半角英数字(15文字)

(マルチロードバランサーユニークIDといずれか)
 
Protocol プロトコル
Type : String
値 : TCP | UDP | HTTP | HTTPS
 
ElasticLoadBalancerPort 待ち受けポート
Type : Integer
値 : 1〜65535の数値
 
InstancePort 宛先ポート
Type : Integer
値 : 1〜65535の数値
 
HealthCheck.Target ヘルスチェック プロトコル
(TCP/HTTP/HTTPS指定の場合 「:宛先ポート」)
Type : String
値 : TCP:宛先ポート(数字 1-65535) | HTTP:宛先ポート(数字 1-65535) | HTTPS:宛先ポート(数字 1-65535) | ICMP
 
HealthCheck.Interval ヘルスチェック間隔(秒)
Type : Integer
単位 : 秒
値 : 5-300
Default : 5
300
HealthCheck.UnhealthyThreshold ヘルスチェック回数閾値
※この回数を超えて連続してチェックに失敗した場合、問題があるものと判断し、該当サーバーをロードバランサーから切り離す。
Type : Integer
値 : 1-10
Default : 1
5
HealthCheck.Path ヘルスチェックパス
Type : String
使用可能文字 : 「!`$#\";」を除く半角英数記号(255文字)
  1. 指定されたHealthCheck.Targetが「HTTP」もしくは「HTTPS」の場合に有効
  2. 先頭が”/”で始まっていること
   
HealthCheck.Expectation.member.n.HttpCode ヘルスチェック期待値
Type : Integer
値 : 200-499
  1. 指定されたHealthCheck.Targetが「HTTP」もしくは「HTTPS」の場合に有効
  2. HTTPステータスコードを指定
  3. 最大10個まで設定可能
   

応答フィールド

フィールド 説明 サンプル値
NiftyConfigureElasticLoadBalancerHealthCheckResponse NiftyConfigureElasticLoadBalancerHealthCheckレスポンス
Type : NiftyConfigureElasticLoadBalancerHealthCheckResponse
Ancestor :なし
Children : NiftyConfigureElasticLoadBalancerHealthCheckResult、ResponseMetadata
 
NiftyConfigureElasticLoadBalancerHealthCheckResult ヘルスチェック設定の情報
Type : NiftyConfigureElasticLoadBalancerHealthCheckResult
Ancestor : なし
Children : HealthCheck
 
HealthCheck ヘルスチェックの設定情報
Type : HealthCheck
Ancestor : NiftyConfigureElasticLoadBalancerHealthCheckResult
Children : Target,Interval, Timeout, UnhealthyThreshold, HealthyThreshold
 
Target ヘルスチェック プロトコル
Type : xsd:string
Ancestor : HealthCheck
Children : なし
 
Interval ヘルスチェック間隔(秒)
Type : xsd:integer
Ancestor : HealthCheck
Children : なし
 
Timeout ※空を返却
タイムアウト
Type : xsd:integer
Ancestor : HealthCheck
Children : なし
 
UnhealthyThreshold ヘルスチェック間隔(秒)
Type : xsd:integer
Ancestor : HealthCheck
Children : なし
 
HealthyThreshold ヘルスチェックの復旧判断
Type : xsd:integer
Ancestor : HealthCheck
Children : なし
※連続してこの値を超えた回数のチェックに成功した場合、復旧したものと判断して該当サーバーをロードバランサーに接続する
 
Path ヘルスチェックパス
Type : xsd:string
Ancestor : HealthCheck
Children : なし
 
Expectation ヘルスチェック期待値セット
Type : Expectation
Ancestor : HealthCheck
Children : HttpCode
 
member ヘルスチェック期待値情報
Type : member
Ancestor : Expectation
Children : HttpCode
 
HttpCode ヘルスチェック期待値
Type : xsd:integer
Ancestor : member
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : NiftyConfigureElasticLoadBalancerHealthCheckResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor :ResponseMetadata
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyConfigureElasticLoadBalancerHealthCheck&ElasticLoadBalancerName=lb0001&Protocol=TCP&ElasticLoadBalancerPort=443&InstancePort=443&HealthCheck.Target=TCP:80&HealthCheck.Interval=300&HealthCheck.Timeout=30&HealthCheck.UnhealthyThreshold=3&HealthCheck.HealthyThreshold=1

応答サンプル

<NiftyConfigureElasticLoadBalancerHealthCheckResponse xmlns="https://cp.cloud.nifty.com/api/">
  <NiftyConfigureElasticLoadBalancerHealthCheckResult>
    <HealthCheck>
      <Target>TCP:80</Target>
      <Interval>300</Interval>
      <Timeout/>
      <UnhealthyThreshold>3</UnhealthyThreshold>
      <HealthyThreshold>1</HealthyThreshold>
    </HealthCheck>
  </NiftyConfigureElasticLoadBalancerHealthCheckResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</NiftyConfigureElasticLoadBalancerHealthCheckResponse>

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

APIメニュー

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

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