ConfigureHealthCheck#

ヘルスチェックを設定します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://nfv.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://nfv.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

POST

/lb/nfv/listeners/{Listener id}/healthcheck

HTTPステータスコード#

正常時：202

エラー時：400,404,500

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定		 Description
Listener id path string 必須 リスナーID
healthcheck body object 必須 ヘルスチェックのオブジェクト
interval body string 60
任意		 ヘルスチェックの実施時間間隔(秒単位)
timeout body string 10
任意		 ヘルスチェック応答のタイムアウト時間(ミリ秒単位)
推奨値である10000ミリ秒(=10秒)を基準に設定してください。
unhealthythreshold body string 3
任意		 対象の分散先サーバを障害と判断し振り分け先から除外するためのヘルスチェック連続失敗回数
target body string ping
任意		 ヘルスチェックの実施方法
http指定でHTTPリクエストによるへするチェックを実施します。
ping指定でICMPによるヘルスチェックを実施します。
url_path body string /index.html
任意		 ヘルスチェックで確認するURLパス
targetとしてhttpを指定した場合だけパラメータは有効です。

レスポンスボディ（正常系）の説明#

名前 Type Description
healthcheck object ヘルスチェックのオブジェクト
interval string ヘルスチェックの実施時間間隔(秒単位)
timeout string ヘルスチェック応答のタイムアウト時間(ミリ秒単位)
unhealthythreshold string 対象の分散先サーバを障害と判断し振り分け先から除外するためのヘルスチェック連続失敗回数
target string ヘルスチェックの実施方法
http指定でHTTPリクエストによるへするチェックを実施します。
ping指定でICMPによるヘルスチェックを実施します。
url_path string ヘルスチェックで確認するURLパス
targetとしてhttpを指定した場合だけパラメータは有効です。
id string リスナーID

リクエスト例#

{
    "healthcheck": {
        "interval": "30",
        "timeout": "5000",
        "unhealthythreshold": "3",
        "target": "ping",
        "url_path": "/index.html"
    }
}

レスポンス例#

{
    "healthcheck": {
        "interval": "30",
        "timeout": "5000",
        "unhealthythreshold": "3",
        "target": "ping",
        "url_path": "/index.html",
        "id":"1642421"
    }
}