Update health monitor#

ヘルスモニターを更新します。

📒注: 本APIは非推奨です。「Update a Health Monitor」をご利用ください。

APIエンドポイント#

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

HTTPメソッドとURI#

PUT

/v2.0/lbaas/healthmonitors/{healthmonitor_id}

HTTPステータスコード#

正常時：202

エラー時：401, 404, 422

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

名前 In Type デフォルト値
/必須指定		 Description
admin_state_up body boolean 必須 リソースの管理状態
「up(true)」または「down(false)」が表示されます。
delay body integer 必須 メンバーへプローブを送る時間間隔(秒単位)
expected_codes body string 任意
200		 メンバーが正常な場合に想定されるHTTPレスポンスステータスコード
以下のように指定します。
- 単独の値
例： 200
- 値のリスト
例： 200、202
- 値の範囲
例： 200-204
healthmonitor body object 必須 ヘルスモニターオブジェクト
healthmonitor_id path string 必須 ヘルスモニターID
http_method body string 必須 ヘルスモニターがリクエストを送る際に利用するHTTPメソッド
max_retries body integer 必須 メンバーのステータスをINACTIVEに変更するまでのリトライ回数
有効な値は1～10です。
timeout body integer 必須 接続がタイムアウトするまでの最大待ち時間
delayより低い値を指定する必要があります。
url_path body string 任意
/		 バックエンドメンバーのヘルスチェックのためにモニターが送信するHTTPリクエストのパス
スラッシュ("/")で始める必要があります。

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

名前 Type Description
admin_state_up boolean リソースの管理状態
「up(true)」または「down(false)」が表示されます。
delay integer メンバーへプローブを送る時間間隔(秒単位)
expected_codes string メンバーが正常な場合に想定されるHTTPレスポンスステータスコード
以下のように返却されます。
- 単独の値
例： 200
- 値の一覧
例： 200、202
- 値の範囲
例： 200-204
healthmonitor object ヘルスモニターオブジェクト
http_method string ヘルスモニターがリクエストを送る際に利用するHTTPメソッド
id string ヘルスモニターID
max_retries integer メンバーのステータスをINACTIVEに変更するまでのリトライ回数
有効な値は1～10です。
pools string 関連付けられるプールのプールID
project_id string プロジェクトID
timeout integer 接続がタイムアウトするまでの最大待ち時間
delayより低い値を指定する必要があります。
type string ヘルスモニターのタイプ
「HTTP」、「HTTPS」、「TCP」のどれかを指定します。
tenant_id string プロジェクトID
url_path string バックエンドメンバーのヘルスチェックのためにモニターが送信するHTTPリクエストのパス
スラッシュ("/")で始めるパスが表示されます。

リクエスト例#

{
    "healthmonitor": {
        "admin_state_up": false,
        "delay": "2",
        "expected_codes": "200",
        "http_method": "POST",
        "max_retries": 2,
        "timeout": 2,
        "url_path": "/page.html"
    }
}

レスポンス例#

{
    "healthmonitor": {
        "admin_state_up": false,
        "project_id": "eabfefa3fd1740a88a47ad98e132d238",
        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
        "delay": 2,
        "expected_codes": "200",
        "max_retries": 2,
        "http_method": "POST",
        "timeout": 2,
        "pools": [
            {
                "status": "ACTIVE",
                "status_description": null,
                "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
            }
        ],
        "url_path": "/page.html",
        "type": "HTTP",
        "id": "b7633ade-24dc-4d72-8475-06aa22be5412"
    }
}
📒注: 本APIによる更新処理は非同期で動作するため、レスポンスボディには更新前の値が返ります。更新後の値を確認するためには、ヘルスモニターの詳細情報を表示するAPI（Show health monitor details）を利用します。値の更新に時間を要する可能性もありますので、その場合は詳細情報を値が更新されるまで繰り返し取得してください。