更新负载均衡器
功能介绍
更新负载均衡器。
调用方法
请参见如何调用API。
URI
PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
loadbalancer_id |
是 |
String |
参数解释:负载均衡器ID。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
project_id |
是 |
String |
参数解释:项目ID。获取方式请参见获取项目ID。 约束限制:不涉及 取值范围:长度为32个字符,由小写字母和数字组成。 默认取值:不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
loadbalancer |
是 |
UpdateLoadBalancerOption object |
参数解释:更新负载均衡器参数对象。 约束限制:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
参数解释:负载均衡器的名称。 约束限制:不涉及 取值范围:支持中文字符、英文字符等unicode字符,且长度为[0-255]个字符。可以为空。 默认取值:不涉及 |
admin_state_up |
否 |
Boolean |
参数解释:负载均衡器的启用状态。 取值范围:
约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
description |
否 |
String |
参数解释:负载均衡器的描述。 约束限制:不涉及 取值范围:支持中文字符、英文字符等unicode字符,且长度为[0-255]个字符。可以为空。 默认取值:不涉及 |
ipv6_vip_virsubnet_id |
否 |
String |
参数解释:双栈类型负载均衡器所在子网的IPv6网络ID,也称为该负载均衡器实例的前端子网。 可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。 更新ipv6_vip_virsubnet_id可以更新负载均衡器所在IPv6子网,且负载均衡器的内网IPv6地址将发生变化,但不会导致IPv4子网发生变化。 约束限制:
取值范围:标准的UUID格式,长度为36个字符。 默认取值:不涉及
说明:
传入为null表示解绑IPv6子网。不变更IPv6子网,请勿传入该字段。
|
vip_subnet_cidr_id |
否 |
String |
参数解释:负载均衡器所在的IPv4子网ID,也称为该负载均衡器实例的前端子网。 可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_subnet_id得到。 更新vip_subnet_cidr_id可以更新负载均衡器所在IPv4子网,并且负载均衡器的私网IPv4地址将发生变化,但不会导致IPv6子网发生变化。 约束限制:
取值范围:标准的UUID格式,长度为36个字符。 默认取值:不涉及
说明:
传入null表示解绑IPv4子网。不变更IPv4子网,请勿传入该字段。
|
vip_address |
否 |
String |
参数解释:负载均衡器的IPv4私网IP。 约束限制:该地址必须包含在所在子网的IPv4网段内,且未被占用。 取值范围:满足IPv4的地址格式,[0-255].[0-255].[0-255].[0-255]. 如192.168.1.1。 默认取值:不涉及 注:仅当guaranteed是true的场合,才支持更新。 |
l4_flavor_id |
否 |
String |
参数解释:网络型规格ID。 可以通过GET https://{ELB_Endpoint}/v3/{project_id}/elb/flavors?type=L4 响应参数中的id得到。 约束限制:
取值范围:不涉及 默认取值:不涉及 |
l7_flavor_id |
否 |
String |
参数解释:应用型ID。 可以通过GET https://{ELB_Endpoint}/v3/{project_id}/elb/flavors?type=L7 响应参数中的id得到。 约束限制:
取值范围:不涉及 默认取值:不涉及 |
ipv6_bandwidth |
否 |
BandwidthRef object |
参数解释:带宽对象ID。 约束限制:
|
ip_target_enable |
否 |
Boolean |
参数解释:是否启用IP类型后端转发。 开启IP类型后端转发后,后端服务器组不仅支持添加云上VPC内的服务器,还支持添加其他VPC、其他公有云、云下数据中心的服务器。 约束限制:
取值范围:
默认取值:不涉及 |
elb_virsubnet_ids |
否 |
Array of strings |
参数解释:下联面子网的网络ID列表。 可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。 约束限制:
取值范围:不涉及 默认取值:不涉及 |
deletion_protection_enable |
否 |
Boolean |
参数解释:是否开启删除保护。 约束限制:退场时需要先关闭所有资源的删除保护开关。 取值范围:false 不开启,true 开启。 默认取值:不涉及 |
prepaid_options |
否 |
PrepaidUpdateOption object |
参数解释:更新负载均衡器实例的预付费计费配置。 约束限制:不涉及 |
autoscaling |
否 |
参数解释:弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。 约束限制:
说明:
该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。
|
|
charge_mode |
否 |
String |
参数解释:计费模式。 约束限制:不涉及 取值范围:
默认取值:不涉及 |
waf_failure_action |
否 |
String |
参数解释:WAF故障时的流量处理策略。 约束限制:只有绑定了waf的LB实例,该字段才会生效。 取值范围:discard:丢弃,forward: 转发到后端。 默认取值:forward |
protection_status |
否 |
String |
参数解释:修改保护状态。 约束限制:不涉及 取值范围:
默认取值:不涉及 |
protection_reason |
否 |
String |
参数解释:设置保护的原因。作为protection_status的转态设置的原因。 约束限制:仅当protection_status为consoleProtection时有效。 取值范围:除'<'和'>'外通用Unicode字符集字符,最大255个字符。 默认取值:不涉及 |
ipv6_vip_address |
否 |
String |
参数解释:双栈类型负载均衡器的IPv6地址。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
auto_pay |
否 |
Boolean |
参数解释:下单订购后,是否自动从客户的账户中支付。 约束限制:自动支付时,只能使用账户的现金支付;如果要使用代金券,请选择不自动支付,然后在用户费用中心,选择代金券支付。 取值范围:
默认取值:不涉及 |
change_mode |
否 |
String |
参数解释:规格变更类型。 约束限制:不涉及 取值范围:
默认取值:不涉及 |
period_num |
否 |
Integer |
参数解释:订购周期数,取值会随运营策略变化。 约束限制:仅在change_mode为delay时生效 取值范围:
默认取值:不涉及 |
period_type |
否 |
String |
参数解释:订购周期类型。 约束限制:仅在change_mode为delay时生效。 取值范围:
默认取值:不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
loadbalancer |
LoadBalancer object |
参数解释:负载均衡器对象。(包周期规格变更场景不返回该字段) |
loadbalancer_id |
String |
参数解释:负载均衡器的ID。(包周期场景返回该字段) 取值范围:不涉及 |
order_id |
String |
参数解释:订单号。(包周期规格变更场景返回该字段) 取值范围:不涉及 |
request_id |
String |
参数解释:请求ID。 取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释:负载均衡器ID。 取值范围:不涉及 |
description |
String |
参数解释:负载均衡器描述信息。 取值范围:不涉及 |
provisioning_status |
String |
参数解释:负载均衡器的配置状态。 取值范围:
|
admin_state_up |
Boolean |
参数解释:负载均衡器的启用状态。 取值范围:
|
provider |
String |
参数解释:负载均衡器的生产者名称。固定为vlb。 取值范围:不涉及 |
pools |
Array of PoolRef objects |
参数解释:负载均衡器直接关联的后端服务器组的ID列表。 |
listeners |
Array of ListenerRef objects |
参数解释:负载均衡器关联的监听器的ID列表。 |
operating_status |
String |
参数解释:负载均衡器的操作状态。 取值范围:
|
name |
String |
参数解释:负载均衡器的名称。 取值范围:不涉及 |
project_id |
String |
参数解释:负载均衡器所属的项目ID。 取值范围:不涉及 |
vip_subnet_cidr_id |
String |
参数解释:负载均衡器所在子网的IPv4子网ID,也称为该负载均衡器实例的前端子网。 取值范围:不涉及 |
vip_address |
String |
参数解释:负载均衡器的IPv4私网IP地址。 取值范围:不涉及 |
vip_port_id |
String |
参数解释:负载均衡器的IPv4对应的port ID。 取值范围:不涉及 |
tags |
Array of Tag objects |
参数解释:负载均衡的标签列表。 |
created_at |
String |
参数解释:负载均衡器的创建时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
updated_at |
String |
参数解释:负载均衡器的更新时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
guaranteed |
Boolean |
参数解释:是否独享型LB。 取值范围:
|
vpc_id |
String |
参数解释:负载均衡器所在VPC ID。 取值范围:不涉及 |
eips |
Array of EipInfo objects |
参数解释:负载均衡器绑定的EIP。
说明:
该字段与publicips一致。
|
ipv6_vip_address |
String |
参数解释:双栈类型负载均衡器的IPv6地址。 取值范围:不涉及 |
ipv6_vip_virsubnet_id |
String |
参数解释:双栈类型负载均衡器所在子网的IPv6网络ID,也称为该负载均衡器实例的前端子网。 取值范围:不涉及 |
ipv6_vip_port_id |
String |
参数解释:双栈类型负载均衡器的IPv6对应的port ID。 取值范围:不涉及 |
availability_zone_list |
Array of strings |
参数解释:负载均衡器所在的可用区列表。 取值范围:不涉及 |
enterprise_project_id |
String |
参数解释:资源所属的企业项目ID。 取值范围:
|
billing_info |
String |
参数解释:资源账单信息。 取值范围:
|
l4_flavor_id |
String |
参数解释:负载均衡器4层规格ID。 若当前负载均衡器是弹性规格实例,则该字段表示4层上限规格。 取值范围:不涉及 |
l4_scale_flavor_id |
String |
参数解释:四层弹性规格ID。 取值范围:不涉及
说明:
该字段已经废弃,请勿使用。
|
l7_flavor_id |
String |
参数解释:负载均衡器7层规格ID。 若当前负载均衡器是弹性规格实例,则该字段表示7层上限规格。 取值范围:不涉及 |
l7_scale_flavor_id |
String |
参数解释:七层弹性Flavor ID。 取值范围:不涉及
说明:
该字段已经废弃,请勿使用。
|
gw_flavor_id |
String |
参数解释:网关型负载均衡器的规格ID。 取值范围:不涉及 不支持该字段,请勿使用。 |
loadbalancer_type |
String |
参数解释:负载均衡器类别。 取值范围:
不支持该字段,请勿使用。 |
publicips |
Array of PublicIpInfo objects |
参数解释:负载均衡器绑定的公网IP。
说明:
该字段与eips一致。
|
global_eips |
Array of GlobalEipInfo objects |
参数解释:负载均衡器绑定的global eip。 |
elb_virsubnet_ids |
Array of strings |
参数解释:下联面子网的网络ID列表。 取值范围:不涉及 |
elb_virsubnet_type |
String |
参数解释:下联面子网类型。 取值范围:
|
ip_target_enable |
Boolean |
参数解释:是否启用IP类型后端转发。 开启IP类型后端转发后,后端服务器组不仅支持添加云上VPC内的服务器,还支持添加其他VPC、其他公有云、云下数据中心的服务器。 取值范围:
|
frozen_scene |
String |
参数解释:负载均衡器的冻结场景。 若负载均衡器有多个冻结场景,用逗号分隔。 取值范围:
|
deletion_protection_enable |
Boolean |
参数解释:是否开启删除保护。仅当前局点启用删除保护特性后才会返回该字段。 取值范围:
|
autoscaling |
AutoscalingRef object |
参数解释:弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。
说明:
该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。
|
public_border_group |
String |
参数解释:公网边界组。 取值范围:
|
charge_mode |
String |
参数解释:负载均衡器实例的计费模式。 取值范围:
|
service_lb_mode |
String |
参数解释:LB模式。 取值范围:
不支持该字段,请勿使用。 |
instance_type |
String |
参数解释:标识实例归属哪个内部服务。 取值范围:不涉及 不支持该字段,请勿使用。 |
instance_id |
String |
参数解释:标识实例绑定内部服务的实例ID。 取值范围:不涉及 不支持该字段,请勿使用。 |
proxy_protocol_extensions |
Array of ProxyProtocolExtension objects |
参数解释:pp扩展。 不支持该字段,请勿使用。 |
waf_failure_action |
String |
参数解释:WAF故障时的流量处理策略。 取值范围:discard:丢弃,forward: 转发到后端。 |
protection_status |
String |
参数解释:修改保护状态。 取值范围:
|
protection_reason |
String |
参数解释:设置保护的原因。作为protection_status的转态设置的原因。 取值范围:除'<'和'>'外通用Unicode字符集字符,最大255个字符。 |
log_group_id |
String |
参数解释:LB所关联的云日志服务(LTS)的日志组ID。 取值范围:不涉及 |
log_topic_id |
String |
参数解释:LB所关联的云日志服务(LTS)的日志组下的日志流ID。 取值范围:不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
eip_id |
String |
参数解释:弹性IP的ID。 取值范围:不涉及 |
eip_address |
String |
参数解释:弹性IP的IP地址。 取值范围:不涉及 |
ip_version |
Integer |
参数解释:IP版本号。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
publicip_id |
String |
参数解释:弹性公网EIP的ID。 取值范围:不涉及 |
publicip_address |
String |
参数解释:EIP的IP地址。 取值范围:不涉及 |
ip_version |
Integer |
参数解释:IP版本信息。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
global_eip_id |
String |
参数解释:global eip的ID。 取值范围:不涉及 |
global_eip_address |
String |
参数解释:global eip的ip地址。 取值范围:不涉及 |
ip_version |
Integer |
参数解释:IP版本信息。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
enable |
Boolean |
参数解释:当前负载均衡器是否开启弹性扩缩容。 取值范围:
|
min_l7_flavor_id |
String |
参数解释:弹性扩缩容的最小七层规格ID(规格类型L7_elastic)。 取值范围:不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
vip_address |
String |
参数解释:ipv4 vip地址。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
ipv6_vip_address |
String |
参数解释:ipv6 vip地址。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
extension |
Extension object |
参数解释:pp 扩展。 约束限制:不涉及 |
请求示例
更新负载均衡器的描述和名称
PUT https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id} { "loadbalancer" : { "description" : "loadbalancer", "name" : "loadbalancer-update" } }
响应示例
状态码:200
操作正常返回。
{ "request_id" : "010dad1e-32a3-4405-ab83-62a1fc5f8722", "loadbalancer" : { "id" : "2e073bf8-edfe-4e51-a699-d915b0b8af89", "project_id" : "b2782e6708b8475c993e6064bc456bf8", "name" : "loadbalancer-update", "description" : "loadbalancer", "vip_port_id" : null, "vip_address" : null, "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ { "id" : "41937176-bf64-4b58-8e0d-9ff2d0d32c54" }, { "id" : "abc6ac93-ad0e-4765-bd5a-eec632efde56" }, { "id" : "b9d8ba97-6d60-467d-838d-f3550b54c22a" }, { "id" : "fd797ebd-263d-4b18-96e9-e9188d36c69e" } ], "pools" : [ { "id" : "0aabcaa8-c35c-4ddc-a60c-9032d0ac0b80" }, { "id" : "165d9092-396e-4a8d-b398-067496a447d2" } ], "tags" : [ ], "provider" : "vlb", "created_at" : "2019-04-20T03:10:37Z", "updated_at" : "2019-05-24T02:11:58Z", "vpc_id" : "2037c5bb-e04b-4de2-9300-9051af18e417", "enterprise_project_id" : "0", "availability_zone_list" : [ "AZ1", "AZ2", "dc3" ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "eips" : [ ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : null, "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : null, "deletion_protection_enable" : false, "public_border_group" : "center" } }
SDK代码示例
SDK代码示例如下。
更新负载均衡器的描述和名称
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class UpdateLoadBalancerSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("<YOUR REGION>")) .build(); UpdateLoadBalancerRequest request = new UpdateLoadBalancerRequest(); request.withLoadbalancerId("{loadbalancer_id}"); UpdateLoadBalancerRequestBody body = new UpdateLoadBalancerRequestBody(); UpdateLoadBalancerOption loadbalancerbody = new UpdateLoadBalancerOption(); loadbalancerbody.withName("loadbalancer-update") .withDescription("loadbalancer"); body.withLoadbalancer(loadbalancerbody); request.withBody(body); try { UpdateLoadBalancerResponse response = client.updateLoadBalancer(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
更新负载均衡器的描述和名称
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateLoadBalancerRequest() request.loadbalancer_id = "{loadbalancer_id}" loadbalancerbody = UpdateLoadBalancerOption( name="loadbalancer-update", description="loadbalancer" ) request.body = UpdateLoadBalancerRequestBody( loadbalancer=loadbalancerbody ) response = client.update_load_balancer(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
更新负载均衡器的描述和名称
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateLoadBalancerRequest{} request.LoadbalancerId = "{loadbalancer_id}" nameLoadbalancer:= "loadbalancer-update" descriptionLoadbalancer:= "loadbalancer" loadbalancerbody := &model.UpdateLoadBalancerOption{ Name: &nameLoadbalancer, Description: &descriptionLoadbalancer, } request.Body = &model.UpdateLoadBalancerRequestBody{ Loadbalancer: loadbalancerbody, } response, err := client.UpdateLoadBalancer(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。