功能介紹
查詢健康檢查。支持過(guò)濾查詢和分頁(yè)查詢。如未特殊說(shuō)明，匹配規(guī)則為精確匹配。
調(diào)試
您可以在API Explorer中直接運(yùn)行調(diào)試該接口。
URI
GET /v2/{project_id}/elb/healthmonitors
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用戶的項(xiàng)目ID。 獲取方法詳見(jiàn)獲取項(xiàng)目ID。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
marker |
否 |
String |
分頁(yè)查詢的起始的資源ID，表示上一頁(yè)最后一條查詢記錄的健康檢查的ID。 必須與limit一起使用。 |
|
limit |
否 |
Integer |
分頁(yè)查詢每頁(yè)的健康檢查個(gè)數(shù)。如果不設(shè)置，則默認(rèn)不分頁(yè)查詢所有。 |
|
page_reverse |
否 |
Boolean |
分頁(yè)的順序，true表示從后往前分頁(yè)，false表示從前往后分頁(yè)，默認(rèn)為false。 必須與limit一起使用。 |
|
id |
否 |
String |
健康檢查ID。 |
|
tenant_id |
否 |
String |
健康檢查所在的項(xiàng)目ID。 支持的最大字符長(zhǎng)度：255 |
|
project_id |
否 |
String |
此參數(shù)和tenant_id參數(shù)含義一樣，均指健康檢查所在的項(xiàng)目ID。 |
|
name |
否 |
String |
健康檢查名稱。 支持的最大字符長(zhǎng)度：255 |
|
delay |
否 |
Integer |
健康檢查間隔，單位秒，取值范圍[1，50]。 |
|
max_retries |
否 |
Integer |
健康檢查連續(xù)成功多少次后，將后端服務(wù)器的健康檢查狀態(tài)由OFFLINE判定為ONLINE，取值范圍[1，10]。 |
|
admin_state_up |
否 |
Boolean |
健康檢查的管理狀態(tài)。 取值范圍：true/false。默認(rèn)為true；
|
|
timeout |
否 |
Integer |
健康檢查超時(shí)時(shí)間，單位秒，取值范圍[1，50]。 說(shuō)明：
建議該值小于delay的值。 |
|
type |
否 |
String |
健康檢查的類型。 取值范圍：TCP、UDP_CONNECT、HTTP。 |
|
monitor_port |
否 |
Integer |
健康檢查端口號(hào)。 默認(rèn)為空，表示使用后端 云服務(wù)器 的protocol_port作為健康檢查的檢查端口。 |
|
expected_codes |
否 |
String |
期望HTTP響應(yīng)狀態(tài)碼，指定下列值： 單值，例如200； 列表，例如200，202； 區(qū)間，例如200-204。 僅當(dāng)type為HTTP時(shí)生效。 支持的最大字符長(zhǎng)度：64 說(shuō)明：
該字段為預(yù)留字段，暫未啟用。 |
|
domain_name |
否 |
String |
健康檢查時(shí)，發(fā)送的http請(qǐng)求的域名。 僅當(dāng)type為HTTP時(shí)生效。 默認(rèn)為空，表示使用 負(fù)載均衡 器的vip_address作為http請(qǐng)求的目的地址。 以數(shù)字或字母開(kāi)頭，只能包含數(shù)字、字母、’-’、’.’。 例如：www.test.com 支持的最大字符長(zhǎng)度：100 |
|
url_path |
否 |
String |
健康檢查時(shí)發(fā)送的http請(qǐng)求路徑。默認(rèn)為“/”。 以“/”開(kāi)頭。 僅當(dāng)type為HTTP時(shí)生效。 例如：“/test” 支持的最大字符長(zhǎng)度：80 |
|
http_method |
否 |
String |
HTTP請(qǐng)求的方法；默認(rèn)值：GET 取值范圍：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 僅當(dāng)type為HTTP時(shí)生效。 說(shuō)明：
該字段為預(yù)留字段，暫未啟用。 |
請(qǐng)求消息
無(wú)
響應(yīng)消息
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
healthmonitors |
|
參數(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 |
Array of Pools objects |
健康檢查關(guān)聯(lián)的后端云服務(wù)器組的ID列表。詳見(jiàn)表6 |
|
admin_state_up |
Boolean |
健康檢查的管理狀態(tài)。 該字段為預(yù)留字段，暫未啟用。取值范圍：true/false。
|
|
timeout |
Integer |
健康檢查超時(shí)時(shí)間，單位秒，取值范圍[1，50]。 說(shuō)明：
建議該值小于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請(qǐng)求的域名。 僅當(dāng)type為HTTP時(shí)生效。 默認(rèn)為空，表示使用負(fù)載均衡器的vip_address作為http請(qǐng)求的目的地址。 以數(shù)字或字母開(kāi)頭，只能包含數(shù)字、字母、’-’、’.’。 例如：www.test.com |
|
url_path |
String |
健康檢查時(shí)發(fā)送的http請(qǐng)求路徑。默認(rèn)為“/”。 以“/”開(kāi)頭。 僅當(dāng)type為HTTP時(shí)生效。 例如：“/test” |
|
http_method |
String |
HTTP請(qǐng)求的方法；默認(rèn)值：GET 取值范圍：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 僅當(dāng)type為HTTP時(shí)生效。 說(shuō)明：
該字段為預(yù)留字段，暫未啟用。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
后端服務(wù)器組id |
請(qǐng)求示例
- 請(qǐng)求樣例1 全量查詢健康檢查
GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/healthmonitors - 請(qǐng)求樣例2 過(guò)濾查詢類型為HTTP的健康檢查
GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/healthmonitors?type=HTTP
響應(yīng)示例
- 響應(yīng)樣例1
{ "healthmonitors": [ { "monitor_port": null, "name": "", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "domain_name": null, "delay": 5, "expected_codes": "200", "max_retries": 3, "http_method": "GET", "timeout": 10, "pools": [ { "id": "caef8316-6b65-4676-8293-cf41fb63cc2a" } ], "url_path": "/", "type": "HTTP", "id": "1b587819-d619-49c1-9101-fe72d8b361ef" } ] } - 響應(yīng)樣例2
{ "healthmonitors": [ { "monitor_port": null, "name": "", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "domain_name": null, "delay": 5, "expected_codes": "200", "max_retries": 3, "http_method": "GET", "timeout": 10, "pools": [ { "id": "caef8316-6b65-4676-8293-cf41fb63cc2a" } ], "url_path": "/", "type": "HTTP", "id": "1b587819-d619-49c1-9101-fe72d8b361ef" } ] }
返回碼
請(qǐng)參見(jiàn)狀態(tài)碼。
