本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> コンピューティング> NiftyConfigureElasticLoadBalancerHealthCheck

NiftyConfigureElasticLoadBalancerHealthCheck

処理概要

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

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

指定するパラメーター

パラメーター 説明 必須
ElasticLoadBalancerId string 対象のマルチロードバランサーユニークID
○ (マルチロードバランサー名といずれか)
ElasticLoadBalancerName string 対象のマルチロードバランサー名
使用可能文字: 半角英数字(15文字)
○ (マルチロードバランサーユニークIDといずれか)
Protocol string プロトコル
値: TCP | UDP | HTTP | HTTPS
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.先頭が”/”で始まっていること
使用可能文字: 「!`$#\";」を除く半角英数記号(255文字)
HealthCheck.Expectation.member.n.HttpCode integer ヘルスチェック期待値
1.指定されたHealthCheck.Targetが「HTTP」もしくは「HTTPS」の場合に有効
2.HTTPステータスコードを指定
3.最大10個まで設定可能
使用可能文字: 200-499

応答フィールド

フィールド (項目) 説明
NiftyConfigureElasticLoadBalancerHealthCheckResponse - NiftyConfigureElasticLoadBalancerHealthCheckレスポンス
Ancestor: なし
Children: NiftyConfigureElasticLoadBalancerHealthCheckResult | ResponseMetadata
NiftyConfigureElasticLoadBalancerHealthCheckResult - ヘルスチェック設定の情報
Ancestor: なし
Children: HealthCheck
HealthCheck - ヘルスチェックの設定情報
Ancestor: NiftyConfigureElasticLoadBalancerHealthCheckResult
Children: Target | Interval | UnhealthyThreshold | Path | Expectation
Target string ヘルスチェック プロトコル
Ancestor: HealthCheck
Children: なし
Interval integer ヘルスチェック間隔(秒)
Ancestor: HealthCheck
Children: なし
UnhealthyThreshold integer ヘルスチェック回数閾値
Ancestor: HealthCheck
Children: なし
Path string ヘルスチェックパス(CDATA付)
Ancestor: HealthCheck
Children: なし
Expectation - ヘルスチェック期待値セット
Ancestor: HealthCheck
Children: member
member - ヘルスチェック期待値情報
Ancestor: Expectation
Children: HttpCode
HttpCode integer ヘルスチェック期待値
Ancestor: member
Children: なし
ResponseMetadata - リクエスト情報
Ancestor: NiftyConfigureElasticLoadBalancerHealthCheckResponse
Children: RequestId
RequestId string リクエスト識別子
Ancestor: ResponseMetadata
Children: なし

リクエストサンプル

    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=200

  

応答サンプル

    <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>200</HttpCode>
        </member>
      </Expectation>
    </HealthCheck>
  </NiftyConfigureElasticLoadBalancerHealthCheckResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</NiftyConfigureElasticLoadBalancerHealthCheckResponse>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2020年11月25日時点の情報です。

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