List Health Monitors#

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

APIエンドポイント#

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

HTTPメソッドとURI#

GET

/v2.0/lbaas/healthmonitors

HTTPステータスコード#

正常時：200

エラー時：400,401,500

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

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

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

名前	Type	Description
admin_state_up	boolean	リソースの管理状態「true」または「false」が表示されます。
created_at	string	リソースが作成された日時(UTC)のタイムスタンプ
delay	integer	メンバーへプローブを送る時間間隔(秒単位)
expected_codes	string	メンバーが正常な場合に想定されるHTTPレスポンスステータスコード - 単独の値例： 200 - 値のリスト例： 200、202 - 値の範囲例： 200-204
healthmonitors	array	ヘルスモニターオブジェクトのリスト
http_method	string	ヘルスモニターがリクエストを送る際に利用するHTTPメソッド「CONNECT」、「DELETE」、「GET」、「HEAD」、「OPTIONS」、「PATCH」、「POST」、「PUT」または「TRACE」が表示されます。
id	uuid	ヘルスモニターID
max_retries	integer	メンバーのoperating_statusをONLINEに変更する前のチェックの成功回数 1～10の値が表示されます。
max_retries_down	integer	メンバーのoperating_statusをERRORに変更する前のチェックの失敗回数 1～10の値が表示されます。
name	string	リソース名
operating_status	string	リソースの運用状況「ONLINE」または「OFFLINE」が表示されます。 operating_statusの詳細は「Operating Status Codes」を参照してください。
pools	array	関連するプールIDの一覧
project_id	string	プロジェクトID
provisioning_status	string	リソースの提供状況「ACTIVE」、「PENDING_CREATE」、「PENDING_UPDATE」または「ERROR」が表示されます。 provisioning_statusの詳細は「Provisioning Status Codes」を参照してください。
timeout	integer	接続がタイムアウトするまでの最大待ち時間 delayより短い期間が表示されます。
type	string	ヘルスモニターのタイプ「HTTP」、「HTTPS」または「TCP」が表示されます。
updated_at	string	リソースの更新日時(UTC)のタイムスタンプ
url_path	string	バックエンドメンバーのヘルスチェックのためにモニターが送信するHTTPリクエストのパススラッシュ("/")で始めるパスが表示されます。

レスポンス例#

{
    "healthmonitors": [
        {
            "admin_state_up": true,
            "created_at": "2019-02-14T01:58:09",
            "delay": 5,
            "expected_codes": null,
            "http_method": null,
            "id": "ee0cc170-6444-42a2-8c4a-a25ff10e437b",
            "max_retries": 3,
            "max_retries_down": 3,
            "name": "",
            "operating_status": "ONLINE",
            "pools": [
                {
                    "id": "a2b550fa-12a1-4781-9b3a-2c88cf3bee5c"
                }
            ],
            "project_id": "51ed616c4bf0440ab6cfe5ff96edce91",
            "provisioning_status": "ACTIVE",
            "timeout": 5,
            "type": "TCP",
            "updated_at": "2019-02-14T01:58:10",
            "url_path": null
        }
    ]
}