功能介紹
更新后端 云服務(wù)器 組。
接口約束
如果與pool綁定的load balancer的provisioning status不是ACTIVE,則不能更新該pool。
調(diào)試
您可以在API Explorer中直接運(yùn)行調(diào)試該接口。
URI
PUT /v2/{project_id}/elb/pools/{pool_id}
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用戶的項(xiàng)目ID。 獲取方法詳見獲取項(xiàng)目ID。 |
|
pool_id |
是 |
String |
后端云服務(wù)器組id。 |
請(qǐng)求消息
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
后端云服務(wù)器組名稱。 支持的最大字符長度:255 |
|
description |
否 |
String |
后端云服務(wù)器組的描述信息。 支持的最大字符長度:255 |
|
lb_algorithm |
否 |
String |
后端云服務(wù)器組的 負(fù)載均衡 算法。 取值范圍:
當(dāng)該字段的取值為SOURCE_IP時(shí),后端云服務(wù)器組綁定的后端云服務(wù)器的weight字段無效。 |
|
admin_state_up |
否 |
Boolean |
后端云服務(wù)器組的管理狀態(tài)。 該字段為預(yù)留字段,暫未啟用。默認(rèn)為true。 |
|
session_persistence |
否 |
當(dāng)開啟會(huì)話保持后,在一定時(shí)間內(nèi),來自同一客戶端的請(qǐng)求會(huì)發(fā)送到同一個(gè)后端云服務(wù)器上。 取值范圍:當(dāng)會(huì)話保持關(guān)閉時(shí),該字段取值為null。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
會(huì)話保持的類型。 取值范圍:
當(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)會(huì)話保持類型是APP_COOKIE時(shí),為必選字段,其它類型時(shí)不可指定。 |
|
persistence_timeout |
否 |
Integer |
會(huì)話保持的超時(shí)時(shí)間。 當(dāng)type為APP_COOKIE時(shí)不生效。 取值范圍:
|
響應(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ù)器組的會(huì)話持久性。詳見表10。 當(dāng)開啟會(huì)話保持后,在一定時(shí)間內(nèi),來自同一客戶端的請(qǐng)求會(huì)發(fā)送到同一個(gè)后端云服務(wù)器上。 取值范圍:當(dāng)會(huì)話保持關(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 |
會(huì)話保持的類型。 取值范圍:
當(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)會(huì)話保持類型是APP_COOKIE時(shí),為必選字段,其它類型時(shí)不可指定。 |
|
persistence_timeout |
否 |
Integer |
會(huì)話保持的超時(shí)時(shí)間。 當(dāng)type為APP_COOKIE時(shí)不生效。 取值范圍:
|
請(qǐng)求示例
- 請(qǐng)求樣例1 更新后端云服務(wù)器組的名稱、描述和負(fù)載均衡算法
PUT https://{Endpoint}/v2/1a3e005cf9ce40308c900bcb08e5320c/elb/pools/12ff63af-4127-4074-a251-bcb2ecc53ebe { "pool": { "name": "pool2", "description": "pool two", "lb_algorithm": "LEAST_CONNECTIONS" } }
響應(yīng)示例
- 響應(yīng)樣例1
{ "pool": { "lb_algorithm": "LEAST_CONNECTIONS", "protocol": "HTTP", "description": "pool two", "admin_state_up": false, "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "project_id": "1a3e005cf9ce40308c900bcb08e5320c", "session_persistence": { "cookie_name": null, "type": "HTTP_COOKIE", "persistence_timeout": 1440 }, "healthmonitor_id": null, "listeners": [ { "id": "39de4d56-d663-46e5-85a1-5b9d5fa17829" } ], "members": [], "id": "12ff63af-4127-4074-a251-bcb2ecc53ebe", "name": "pool2" } }
返回碼
請(qǐng)參見狀態(tài)碼。
最新文章
- 函數(shù)工作流自動(dòng)更新ECS證書_ECS證書自動(dòng)更新_彈性云服務(wù)器
- API網(wǎng)關(guān)跨VPC開放后端服務(wù)_API開放后端服務(wù)_API網(wǎng)關(guān)APIG-華為云
- 如何快速部署高可用四層負(fù)載均衡_四層負(fù)載均衡是什么意思_華為云四層負(fù)載均衡-華為云
- 負(fù)載均衡策略_負(fù)載均衡方式_什么叫負(fù)載均衡
- 負(fù)載均衡的作用_彈性負(fù)載均衡_如何實(shí)現(xiàn)負(fù)載均衡
- 彈性負(fù)載均衡ELB購買指南_彈性負(fù)載均衡操作指南_彈性負(fù)載均衡簡(jiǎn)介
