List health monitors#

ヘルスモニターを一覧表示します。

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

APIエンドポイント#

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

HTTPメソッドとURI#

GET

/v2.0/lbaas/healthmonitors

HTTPステータスコード#

正常時:200

エラー時:401

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

名前 In Type デフォルト値
/必須指定
Description
fields query string 任意 属性を指定します。省略した場合は、すべての属性が表示されます。
複数指定ができます。例えば、fields=id&fields=nameと指定すると、「id」と「name」の属性だけが表示されます。

レスポンスボディ(正常系)の説明#

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

レスポンス例#

{
    "healthmonitors": [
        {
            "admin_state_up": true,
            "project_id": "eabfefa3fd1740a88a47ad98e132d238",
            "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
            "delay": 1,
            "expected_codes": "200,201,202",
            "max_retries": 5,
            "http_method": "GET",
            "timeout": 1,
            "pools": [
                {
                    "status": "ACTIVE",
                    "status_description": null,
                    "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
                }
            ],
            "url_path": "/index.html",
            "type": "HTTP",
            "id": "b7633ade-24dc-4d72-8475-06aa22be5412"
        }
    ]
}