功能介紹
為后端 云服務(wù)器 組創(chuàng)建健康檢查，用來檢查該后端云服務(wù)器組關(guān)聯(lián)的后端云服務(wù)器的狀態(tài)，如果檢查狀態(tài)為OFFLINE則表示后端云服務(wù)器的服務(wù)異常，請檢查服務(wù)器的配置。
接口約束
- 安全組需放通網(wǎng)段100.125.0.0/16流量。
- UDP的檢查健康只能使用在UDP的后端云服務(wù)器組上。
調(diào)試
您可以在API Explorer中直接運(yùn)行調(diào)試該接口。
URI
POST /v2/{project_id}/elb/healthmonitors
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用戶的項(xiàng)目ID。 獲取方法詳見獲取項(xiàng)目ID。 |
請求消息
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
tenant_id |
否 |
String |
健康檢查所在的項(xiàng)目ID。 獲取方法詳見獲取項(xiàng)目ID。 需要和token中的project_id一致。 支持的最大字符長度：255 |
|
name |
否 |
String |
健康檢查名稱。 支持的最大字符長度：255 |
|
delay |
是 |
Integer |
健康檢查的間隔，單位秒，取值范圍[1，50]。 |
|
max_retries |
是 |
Integer |
健康檢查最大重試次數(shù)，取值范圍[1，10]。 |
|
pool_id |
是 |
String |
健康檢查關(guān)聯(lián)的后端云服務(wù)器組ID。 每個(gè)后端云服務(wù)器組只能有一個(gè)健康檢查。 |
|
admin_state_up |
否 |
Boolean |
健康檢查的管理狀態(tài)。 該字段為預(yù)留字段，暫未啟用。默認(rèn)為true。 |
|
timeout |
是 |
Integer |
健康檢查超時(shí)時(shí)間，單位秒，取值范圍[1，50]。 說明：
建議該值小于delay的值。 |
|
type |
是 |
String |
健康檢查的類型。 取值范圍：TCP、UDP_CONNECT、HTTP。 |
|
monitor_port |
否 |
Integer |
健康檢查端口號(hào)，取值范圍[1，65535]。 默認(rèn)為空，表示使用后端云服務(wù)器的protocol_port作為健康檢查的檢查端口。 |
|
domain_name |
否 |
String |
健康檢查時(shí)，發(fā)送的http請求的域名。 僅當(dāng)type為HTTP時(shí)生效。 默認(rèn)為空，表示使用 負(fù)載均衡 器的vip_address作為http請求的目的地址。 以數(shù)字或字母開頭，只能包含數(shù)字、字母、’-’、’.’。 例如：www.test.com 支持的最大字符長度：100 |
|
url_path |
否 |
String |
健康檢查時(shí)發(fā)送的http請求路徑。默認(rèn)為“/”。 以“/”開頭。 僅當(dāng)type為HTTP時(shí)生效。 例如：“/test” 支持的最大字符長度：80 |
|
expected_codes |
否 |
String |
期望HTTP響應(yīng)狀態(tài)碼，指定下列值： 單值，例如200； 列表，例如200，202； 區(qū)間，例如200-204。 僅當(dāng)type為HTTP時(shí)生效。 支持的最大字符長度：64 說明：
該字段為預(yù)留字段，暫未啟用。 |
|
http_method |
否 |
String |
HTTP請求的方法；默認(rèn)值：GET 取值范圍：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 僅當(dāng)type為HTTP時(shí)生效。 說明：
該字段為預(yù)留字段，暫未啟用。 |
響應(yīng)消息
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
健康檢查ID。 |
|
tenant_id |
String |
健康檢查所在的項(xiàng)目ID。 |
|
project_id |
String |
此參數(shù)和tenant_id參數(shù)含義一樣，均指健康檢查所在的項(xiàng)目ID。 |
|
name |
String |
健康檢查名稱。 |
|
delay |
Integer |
健康檢查間隔，單位秒，取值范圍[1，50]。 |
|
max_retries |
Integer |
健康檢查最大重試次數(shù)，取值范圍[1，10]。 |
|
pools |
||
|
admin_state_up |
Boolean |
健康檢查的管理狀態(tài)。 該字段為預(yù)留字段，暫未啟用。取值范圍：true/false。
|
|
timeout |
Integer |
健康檢查超時(shí)時(shí)間，單位秒，取值范圍[1，50]。 說明：
建議該值小于delay的值。 |
|
type |
String |
健康檢查的類型。 取值范圍：TCP、UDP_CONNECT、HTTP。 |
|
monitor_port |
Integer |
健康檢查端口號(hào)，取值范圍[1，65535]。 默認(rèn)為空，表示使用后端云服務(wù)器的protocol_port作為健康檢查的檢查端口。 |
|
expected_codes |
String |
期望HTTP響應(yīng)狀態(tài)碼，指定下列值： 單值，例如200； 列表，例如200，202； 區(qū)間，例如200-204。 僅當(dāng)type為HTTP時(shí)生效。 暫時(shí)不支持該字段，統(tǒng)一置為200。 |
|
domain_name |
String |
健康檢查時(shí)，發(fā)送的http請求的域名。 僅當(dāng)type為HTTP時(shí)生效。 默認(rèn)為空，表示使用負(fù)載均衡器的vip_address作為http請求的目的地址。 以數(shù)字或字母開頭，只能包含數(shù)字、字母、’-’、’.’。 例如：www.test.com |
|
url_path |
String |
健康檢查時(shí)發(fā)送的http請求路徑。默認(rèn)為“/”。 以“/”開頭。 僅當(dāng)type為HTTP時(shí)生效。 例如：“/test” |
|
http_method |
String |
HTTP請求的方法；默認(rèn)值：GET 取值范圍：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 僅當(dāng)type為HTTP時(shí)生效。 說明：
該字段為預(yù)留字段，暫未啟用。 |
請求示例
- 請求樣例1 創(chuàng)建健康檢查
POST https://{Endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/healthmonitors { "healthmonitor": { "admin_state_up": true, "pool_id": "bb44bffb-05d9-412c-9d9c-b189d9e14193", "domain_name": "www.test.com", "delay": 10, "max_retries": 10, "timeout": 10, "type": "HTTP" } }
響應(yīng)示例
- 響應(yīng)樣例1
{ "healthmonitor": { "name": "", "admin_state_up": true, "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "domain_name": "www.test.com", "delay": 10, "expected_codes": "200", "max_retries": 10, "http_method": "GET", "timeout": 10, "pools": [ { "id": "bb44bffb-05d9-412c-9d9c-b189d9e14193" } ], "url_path": "/", "type": "HTTP", "id": "2dca3867-98c5-4cde-8f2c-b89ae6bd7e36", "monitor_port": 112 } }
返回碼
請參見狀態(tài)碼。
