功能介紹
查詢后端 云服務器 組列表。支持過濾查詢和分頁查詢。如未特殊說明,匹配規(guī)則為精確匹配。
調試
您可以在API Explorer中直接運行調試該接口。
URI
GET /v2/{project_id}/elb/pools
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用戶的項目ID。 獲取方法詳見獲取項目ID。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
marker |
否 |
String |
分頁查詢的起始的資源ID,表示上一頁最后一條查詢記錄的后端云服務器組的ID。不指定時表示查詢第一頁。 必須與limit一起使用。 |
|
limit |
否 |
Integer |
分頁查詢每頁的后端云服務器組個數(shù)。如果不設置,則默認不分頁查詢所有。 |
|
page_reverse |
否 |
Boolean |
分頁的順序,true表示從后往前分頁,false表示從前往后分頁,默認為false。 必須與limit一起使用。 |
|
id |
否 |
String |
后端云服務器組ID。 |
|
name |
否 |
String |
后端云服務器組名稱。 支持的最大字符長度:255 |
|
description |
否 |
String |
后端云服務器組的描述信息。 支持的最大字符長度:255 |
|
healthmonitor_id |
否 |
String |
后端云服務器組關聯(lián)的健康檢查的ID。 |
|
loadbalancer_id |
否 |
String |
后端云服務器組關聯(lián)的 負載均衡 器ID。 |
|
protocol |
否 |
String |
后端云服務器組的后端協(xié)議。 支持TCP、UDP和HTTP。 |
|
lb_algorithm |
否 |
String |
后端云服務器組的負載均衡算法。 取值范圍:
當該字段的取值為SOURCE_IP時,后端云服務器組綁定的后端云服務器的weight字段無效。 |
|
member_address |
否 |
String |
后端云服務器組關聯(lián)的后端云服務器IP。 |
|
member_device_id |
否 |
String |
后端云服務器組關聯(lián)的后端云服務器對應的彈性云服務器的ID。 |
|
enterprise_project_id |
否 |
String |
企業(yè)項目ID,僅用于基于企業(yè)項目的細粒度鑒權使用。
|
請求消息
無
響應消息
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
后端云服務器組 ID。 |
|
tenant_id |
String |
后端云服務器組所屬的項目 ID。 支持的最大字符長度:255 |
|
project_id |
String |
此參數(shù)和tenant_id參數(shù)含義一樣,均指后端云服務器組所屬的項目 ID。 |
|
name |
String |
后端云服務器組名稱。 支持的最大字符長度:255 |
|
description |
String |
后端云服務器組的描述信息。 支持的最大字符長度:255 |
|
protocol |
String |
后端云服務器組的后端協(xié)議。 取值范圍:TCP、UDP和HTTP。 當指定listener_id創(chuàng)建后端云服務器組時,后端云服務器組的protocol和它關聯(lián)的監(jiān)聽器的protocol有如下關系:
|
|
lb_algorithm |
String |
后端云服務器組的負載均衡算法。 取值范圍:
|
|
members |
Array of Members objects |
后端云服務器組關聯(lián)的后端云服務器ID的列表。詳見表7 |
|
healthmonitor_id |
String |
后端云服務器組關聯(lián)的健康檢查的ID。 |
|
admin_state_up |
Boolean |
后端云服務器組的管理狀態(tài)。 該字段為預留字段,暫未啟用。取值范圍:true/false。
|
|
listeners |
Array of Listeners objects |
后端云服務器組關聯(lián)的監(jiān)聽器ID列表。詳見表8 |
|
loadbalancers |
Array of Loadbalancers objects |
后端云服務器組關聯(lián)的負載均衡器ID列表。詳見表9 |
|
session_persistence |
SessionPersistence object |
后端云服務器組的會話持久性。詳見表10。 當開啟會話保持后,在一定時間內(nèi),來自同一客戶端的請求會發(fā)送到同一個后端云服務器上。 取值范圍:當會話保持關閉時,該字段取值為null。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
關聯(lián)的后端服務器id |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
關聯(lián)的后端服務器組id |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
關聯(lián)的負載均衡器id |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
會話保持的類型。 取值范圍:
當后端云服務器組的protocol為TCP時,只按SOURCE_IP生效;當后端云服務器組的protocol為HTTP時,只按HTTP_COOKIE、APP_COOKIE生效。 |
|
cookie_name |
否 |
String |
cookie名稱。支持字母、數(shù)字、中劃線(-)和下劃線(_),最大長度64個字符。 當會話保持類型是APP_COOKIE時,為必選字段,其它類型時不可指定。 |
|
persistence_timeout |
否 |
Integer |
會話保持的超時時間。 當type為APP_COOKIE時不生效。 取值范圍:
|
請求示例
- 請求樣例1 全量查詢后端云服務器組
GET https://{Endpoint}/v2/1867112d054b427e808cc6096d8193a1/elb/pools
- 請求樣例2 過濾查詢負載均衡算法為SOURCE_IP的后端云服務器組
GET https://{Endpoint}/v2/1867112d054b427e808cc6096d8193a1/elb/pools?lb_algorithm=SOURCE_IP
響應示例
- 響應樣例1
{ "pools": [ { "lb_algorithm": "SOURCE_IP", "protocol": "TCP", "description": "", "admin_state_up": true, "loadbalancers": [ { "id": "07d28d4a-4899-40a3-a939-5d09d69019e1" } ], "tenant_id": "1867112d054b427e808cc6096d8193a1", "project_id": "1867112d054b427e808cc6096d8193a1", "session_persistence": null, "healthmonitor_id": null, "listeners": [ { "id": "1b421c2d-7e78-4a78-9ee4-c8ccba41f15b" } ], "members": [ { "id": "88f9c079-29cb-435a-b98f-0c5c0b90c2bd" }, { "id": "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c" } ], "id": "3a9f50bb-f041-4eac-a117-82472d8a0007", "name": "my-pool" } ] }
- 響應樣例2
{ "pools": [ { "lb_algorithm": "SOURCE_IP", "protocol": "TCP", "description": "", "admin_state_up": true, "loadbalancers": [ { "id": "07d28d4a-4899-40a3-a939-5d09d69019e1" } ], "tenant_id": "1867112d054b427e808cc6096d8193a1", "project_id": "1867112d054b427e808cc6096d8193a1", "session_persistence": null, "healthmonitor_id": null, "listeners": [ { "id": "1b421c2d-7e78-4a78-9ee4-c8ccba41f15b" } ], "members": [ { "id": "88f9c079-29cb-435a-b98f-0c5c0b90c2bd" }, { "id": "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c" } ], "id": "3a9f50bb-f041-4eac-a117-82472d8a0007", "name": "my-pool" } ] }
返回碼
請參見狀態(tài)碼。
