功能介绍
更新 负载均衡 器的名称或描述信息。
调试
您可以在API Explorer中直接运行调试该接口。
URI
PUT /v2/{project_id}/elb/loadbalancers/{loadbalancer_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用户的项目ID。 获取方法详见获取项目ID。 |
|
loadbalancer_id |
是 |
String |
负载均衡器id。 |
请求消息
响应消息
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
负载均衡器ID。 |
|
project_id |
String |
负载均衡器所在项目的ID。 |
|
tenant_id |
String |
负载均衡器所在项目的ID。 支持的最大字符长度：255 |
|
name |
String |
负载均衡器名称。 支持的最大字符长度：255 |
|
description |
String |
负载均衡器的描述信息。 支持的最大字符长度：255 |
|
vip_subnet_id |
String |
负载均衡器所在的子网IPv4子网ID。 |
|
vip_port_id |
String |
负载均衡器内网IP对应的端口ID。 |
|
provider |
String |
负载均衡器的生产者名称。 |
|
vip_address |
String |
负载均衡器的内网IP。 支持的最大字符长度：64 |
|
listeners |
Array of Listeners objects |
负载均衡器关联监听器ID的列表。详见表6 |
|
pools |
Array of Pools objects |
负载均衡器关联后端服务器组ID的列表。详见表7 |
|
operating_status |
String |
负载均衡器的操作状态。取值范围：可以为ONLINE和FROZEN。 |
|
provisioning_status |
String |
该字段为预留字段，暂未启用。 负载均衡器的配置状态。取值范围：可以为ACTIVE。 |
|
admin_state_up |
Boolean |
负载均衡器的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。
|
|
tags |
Array |
负载均衡器的标签列表。 |
|
created_at |
String |
负载均衡器的创建时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 |
|
updated_at |
String |
负载均衡器的更新时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 |
|
ent erp rise_project_id |
String |
企业项目ID。创建负载均衡器时，给负载均衡器绑定企业项目ID。 取值范围：带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。 说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
关联的监听器id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
关联的后端服务器组id |
请求示例
- 请求样例
PUT https://{Endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/loadbalancers/1e11b74e-30b7-4b78-b09b-84aec4a04487 { "loadbalancer": { "name": "lb_update_test", "description": "lb update test" } }
响应示例
- 响应样例
{ "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" } }
返回码
请参见状态码。
