Create Health Monitor#

ヘルスモニターを作成します。

APIエンドポイント#

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

HTTPメソッドとURI#

POST

/v2.0/lbaas/healthmonitors

HTTPステータスコード#

正常時：201

エラー時：400,401,403,404,409,500,503

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

名前	In	Type	デフォルト値 /必須指定	Description
admin_state_up	body	boolean	任意	リソースの管理状態「true」または「false」を指定します。
delay	body	integer	必須	メンバーへプローブを送る時間間隔(秒単位)
expected_codes	body	string	200 任意	メンバーが正常な場合に想定されるHTTPレスポンスステータスコード - 単独の値例： 200 - 値のリスト例： 200、202 - 値の範囲例： 200-204 📒注: typeに「HTTP」、「HTTPS」以外を指定した場合はこのパラメータは設定できません。
healthmonitor	body	object	必須	ヘルスモニターオブジェクト
http_method	body	string	任意	ヘルスモニターがリクエストを送る際に利用するHTTPメソッド「CONNECT」、「DELETE」、「GET」、「HEAD」、「OPTIONS」、「PATCH」、「POST」、「PUT」または「TRACE」を指定します。 📒注: typeに「HTTP」、「HTTPS」以外を指定した場合はこのパラメータは設定できません。
max_retries	body	integer	必須	メンバーのoperating statusをONLINEに変更する前のチェックの成功回数 1～10の値が指定可能です。
max_retries_down	body	integer	任意	メンバーのoperating statusをERRORに変更する前のチェックの失敗回数 1～10の値が指定可能です。
name	body	string	任意	リソース名
pool_id	body	uuid	必須	プールID
project_id	body	string	任意	プロジェクトID
timeout	body	integer	必須	接続がタイムアウトするまでの最大待ち時間 delayより短い期間を指定する必要があります。
type	body	string	必須	ヘルスモニターのタイプ「HTTP」、「HTTPS」または「TCP」を指定します。 📒注: 「HTTP」、「HTTPS」以外を指定した場合は expected_codes、http_method、url_path のパラメータは設定できません。
url_path	body	string	任意	バックエンドメンバーのヘルスチェックのためにモニターが送信するHTTPリクエストのパススラッシュ("/")で始める必要があります。 📒注: typeに「HTTP」、「HTTPS」以外を指定した場合はこのパラメータは設定できません。

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

名前	Type	Description
admin_state_up	boolean	リソースの管理状態「true」または「false」が表示されます。
created_at	string	リソースが作成された日時(UTC)のタイムスタンプ
delay	integer	メンバーへプローブを送る時間間隔(秒単位)
expected_codes	string	メンバーが正常な場合に想定されるHTTPレスポンスステータスコード - 単独の値例： 200 - 値のリスト例： 200、202 - 値の範囲例： 200-204
healthmonitor	object	ヘルスモニターオブジェクト
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」または「ERROR」が表示されます。 provisioning_statusの詳細は「Provisioning Status Codes」を参照してください。
timeout	integer	接続がタイムアウトするまでの最大待ち時間 delayより短い期間が表示されます。
type	string	ヘルスモニターのタイプ「HTTP」、「HTTPS」または「TCP」が表示されます。
updated_at	string	リソースの更新日時(UTC)のタイムスタンプ
url_path	string	バックエンドメンバーのヘルスチェックのためにモニターが送信するHTTPリクエストのパススラッシュ("/")で始めるパスが表示されます。

リクエスト例#

{
	"healthmonitor":{
		"delay":10,
		"max_retries":5,
		"max_retries_down":5,
		"pool_id":"6e255533-98e5-45d1-aac7-918829cbae38",
		"timeout":5,
		"type":"HTTP",
		"url_path":"/"
	}
}

レスポンス例#

{
    "healthmonitor": {
        "admin_state_up": true,
        "created_at": "2019-03-25T01:28:56",
        "delay": 10,
        "expected_codes": "200",
        "http_method": "GET",
        "id": "6645c0d0-f566-47d6-827a-6c0f584b2305",
        "max_retries": 5,
        "max_retries_down": 5,
        "name": "",
        "operating_status": "OFFLINE",
        "pools": [
            {
                "id": "6e255533-98e5-45d1-aac7-918829cbae38"
            }
        ],
        "project_id": "51ed616c4bf0440ab6cfe5ff96edce91",
        "provisioning_status": "PENDING_CREATE",
        "timeout": 5,
        "type": "HTTP",
        "updated_at": null,
        "url_path": "/welcome.html"
    }
}