功能介紹
根據(jù)后端 云服務(wù)器 組的ID查詢后端云服務(wù)器組詳情。
調(diào)試
您可以在API Explorer中直接運(yùn)行調(diào)試該接口。
URI
GET /v2/{project_id}/elb/pools/{pool_id}
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用戶的項(xiàng)目ID。 獲取方法詳見獲取項(xiàng)目ID。 |
|
pool_id |
是 |
String |
后端云服務(wù)器組ID。 |
請求消息
無
響應(yīng)消息
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
后端云服務(wù)器組 ID。 |
|
tenant_id |
String |
后端云服務(wù)器組所屬的項(xiàng)目 ID。 支持的最大字符長度:255 |
|
project_id |
String |
此參數(shù)和tenant_id參數(shù)含義一樣,均指后端云服務(wù)器組所屬的項(xiàng)目 ID。 |
|
name |
String |
后端云服務(wù)器組名稱。 支持的最大字符長度:255 |
|
description |
String |
后端云服務(wù)器組的描述信息。 支持的最大字符長度:255 |
|
protocol |
String |
后端云服務(wù)器組的后端協(xié)議。 取值范圍:TCP、UDP和HTTP。 當(dāng)指定listener_id創(chuàng)建后端云服務(wù)器組時(shí),后端云服務(wù)器組的protocol和它關(guān)聯(lián)的監(jiān)聽器的protocol有如下關(guān)系:
|
|
lb_algorithm |
String |
后端云服務(wù)器組的 負(fù)載均衡 算法。 取值范圍:
|
|
members |
Array of Members objects |
后端云服務(wù)器組關(guān)聯(lián)的后端云服務(wù)器ID的列表。詳見表7 |
|
healthmonitor_id |
String |
后端云服務(wù)器組關(guān)聯(lián)的健康檢查的ID。 |
|
admin_state_up |
Boolean |
后端云服務(wù)器組的管理狀態(tài)。 該字段為預(yù)留字段,暫未啟用。取值范圍:true/false。
|
|
listeners |
Array of Listeners objects |
后端云服務(wù)器組關(guān)聯(lián)的監(jiān)聽器ID列表。詳見表8 |
|
loadbalancers |
Array of Loadbalancers objects |
后端云服務(wù)器組關(guān)聯(lián)的負(fù)載均衡器ID列表。詳見表9 |
|
session_persistence |
SessionPersistence object |
后端云服務(wù)器組的會話持久性。詳見表10。 當(dāng)開啟會話保持后,在一定時(shí)間內(nèi),來自同一客戶端的請求會發(fā)送到同一個(gè)后端云服務(wù)器上。 取值范圍:當(dāng)會話保持關(guān)閉時(shí),該字段取值為null。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
關(guān)聯(lián)的后端服務(wù)器id |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
關(guān)聯(lián)的后端服務(wù)器組id |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
關(guān)聯(lián)的負(fù)載均衡器id |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
會話保持的類型。 取值范圍:
當(dāng)后端云服務(wù)器組的protocol為TCP時(shí),只按SOURCE_IP生效;當(dāng)后端云服務(wù)器組的protocol為HTTP時(shí),只按HTTP_COOKIE、APP_COOKIE生效。 |
|
cookie_name |
否 |
String |
cookie名稱。支持字母、數(shù)字、中劃線(-)和下劃線(_),最大長度64個(gè)字符。 當(dāng)會話保持類型是APP_COOKIE時(shí),為必選字段,其它類型時(shí)不可指定。 |
|
persistence_timeout |
否 |
Integer |
會話保持的超時(shí)時(shí)間。 當(dāng)type為APP_COOKIE時(shí)不生效。 取值范圍:
|
請求示例
- 請求樣例1 查詢后端云服務(wù)器組的詳情
GET https://{Endpoint}/v2/1867112d054b427e808cc6096d8193a1/elb/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332
響應(yīng)示例
- 響應(yīng)樣例1
{ "pool": { "lb_algorithm": "SOURCE_IP", "protocol": "TCP", "description": "", "admin_state_up": true, "loadbalancers": [ { "id": "6f52004c-3fe9-4c09-b8ce-ed9d9c74a3b1" } ], "tenant_id": "1867112d054b427e808cc6096d8193a1", "project_id": "1867112d054b427e808cc6096d8193a1", "session_persistence": null, "healthmonitor_id": null, "listeners": [ { "id": "6e29b2cd-4e53-40f6-ae7b-29e918de67f2" } ], "members": [], "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", "name": "my-pool" } }
返回碼
請參見狀態(tài)碼。
