功能介紹
更新 負(fù)載均衡 器的名稱(chēng)或描述信息。
調(diào)試
您可以在API Explorer中直接運(yùn)行調(diào)試該接口。
URI
PUT /v2/{project_id}/elb/loadbalancers/{loadbalancer_id}
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用戶(hù)的項(xiàng)目ID。 獲取方法詳見(jiàn)獲取項(xiàng)目ID。 |
|
loadbalancer_id |
是 |
String |
負(fù)載均衡器id。 |
請(qǐng)求消息
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
loadbalancer |
是 |
響應(yīng)消息
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
loadbalancer |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
id |
String |
負(fù)載均衡器ID。 |
|
project_id |
String |
負(fù)載均衡器所在項(xiàng)目的ID。 |
|
tenant_id |
String |
負(fù)載均衡器所在項(xiàng)目的ID。 支持的最大字符長(zhǎng)度：255 |
|
name |
String |
負(fù)載均衡器名稱(chēng)。 支持的最大字符長(zhǎng)度：255 |
|
description |
String |
負(fù)載均衡器的描述信息。 支持的最大字符長(zhǎng)度：255 |
|
vip_subnet_id |
String |
負(fù)載均衡器所在的子網(wǎng)IPv4子網(wǎng)ID。 |
|
vip_port_id |
String |
負(fù)載均衡器內(nèi)網(wǎng)IP對(duì)應(yīng)的端口ID。 |
|
provider |
String |
負(fù)載均衡器的生產(chǎn)者名稱(chēng)。 |
|
vip_address |
String |
負(fù)載均衡器的內(nèi)網(wǎng)IP。 支持的最大字符長(zhǎng)度：64 |
|
listeners |
Array of Listeners objects |
負(fù)載均衡器關(guān)聯(lián)監(jiān)聽(tīng)器ID的列表。詳見(jiàn)表6 |
|
pools |
Array of Pools objects |
負(fù)載均衡器關(guān)聯(lián)后端服務(wù)器組ID的列表。詳見(jiàn)表7 |
|
operating_status |
String |
負(fù)載均衡器的操作狀態(tài)。取值范圍：可以為ONLINE和FROZEN。 |
|
provisioning_status |
String |
該字段為預(yù)留字段，暫未啟用。 負(fù)載均衡器的配置狀態(tài)。取值范圍：可以為ACTIVE。 |
|
admin_state_up |
Boolean |
負(fù)載均衡器的管理狀態(tài)。 該字段為預(yù)留字段，暫未啟用。取值范圍：true/false。
|
|
tags |
Array |
負(fù)載均衡器的標(biāo)簽列表。 |
|
created_at |
String |
負(fù)載均衡器的創(chuàng)建時(shí)間。 格式為UTC時(shí)間：YYYY-MM-DDTHH:MM:SS 支持的最大字符長(zhǎng)度：19 |
|
updated_at |
String |
負(fù)載均衡器的更新時(shí)間。 格式為UTC時(shí)間：YYYY-MM-DDTHH:MM:SS 支持的最大字符長(zhǎng)度：19 |
|
enterprise_project_id |
String |
企業(yè)項(xiàng)目ID。創(chuàng)建負(fù)載均衡器時(shí)，給負(fù)載均衡器綁定企業(yè)項(xiàng)目ID。 取值范圍：帶“-”連字符的UUID格式，或者是字符串“0”?！?”表示默認(rèn)企業(yè)項(xiàng)目。 說(shuō)明：
關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息，請(qǐng)參見(jiàn)《企業(yè)管理用戶(hù)指南》。 |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
id |
String |
關(guān)聯(lián)的監(jiān)聽(tīng)器id |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
id |
String |
關(guān)聯(lián)的后端服務(wù)器組id |
請(qǐng)求示例
- 請(qǐng)求樣例
PUT https://{Endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/loadbalancers/1e11b74e-30b7-4b78-b09b-84aec4a04487 { "loadbalancer": { "name": "lb_update_test", "description": "lb update test" } }
響應(yīng)示例
- 響應(yīng)樣例
{ "loadbalancer": { "description": "simple lb2", "admin_state_up": true, "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "provisioning_status": "ACTIVE", "vip_subnet_id": "823d5866-6e30-45c2-9b1a-a1ebc3757fdb", "listeners": [ { "id": "37ffe679-08ef-436e-b6bd-cf66fb4c3de2" } ], "vip_address": "192.172.1.68", "vip_port_id": "f42e3019-67f7-4d2a-8d1c-af49e7c22fa6", "provider": "vlb", "tags": [], "pools": [ { "id": "75c4f2d4-a213-4408-9fa8-d64708e8d1df" } ], "id": "c32a9f9a-0cc6-4f38-bb9c-cde79a533c19", "operating_status": "ONLINE", "name": "loadbalancer-test2", "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } }
返回碼
請(qǐng)參見(jiàn)狀態(tài)碼。
