更新负载均衡器

loadbalancer_id

是

String

负载均衡器ID。

project_id

是

String

负载均衡器所在的项目ID。

X-Auth-Token

是

String

参数解释：IAM鉴权Token。

loadbalancer

是

UpdateLoadBalancerOption object

参数解释：负载均衡器对象。

name

否

String

参数解释：负载均衡器的名称。

admin_state_up

否

Boolean

参数解释：负载均衡器的启用状态。

取值范围：

• true ：启用。

• false：停用。

description

否

String

参数解释：负载均衡器的描述。

ipv6_vip_virsubnet_id

否

String

参数解释：双栈类型负载均衡器所在子网的IPv6网络ID，也称为该负载均衡器实例的前端子网。可以通过GET

https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。

通过更新ipv6_vip_virsubnet_id可以更新负载均衡器所在IPv6子网，且负载均衡器的内网IPv6地址将发生变化。

约束限制：

• ipv6_vip_virsubnet_id 对应的子网必须属于当前负载均衡器所在VPC，且子网需开启支持IPv6。

• 只有guaranteed是true的负载均衡器才支持更新ipv6_vip_virsubnet_id。

• 传入为null表示解绑IPv6子网。

• 更新IPv6子网不会导致IPv4子网发生变化。

vip_subnet_cidr_id

否

String

参数解释：负载均衡器所在的IPv4子网ID，也称为该负载均衡器实例的前端子网。可以通过GET

https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_subnet_id得到。

通过更新vip_subnet_cidr_id可以更新负载均衡器所在IPv4子网，并且负载均衡器的内网IPv4地址将发生变化。

约束限制：

• 若同时设置了vip_address，则必须保证vip_address对应的IP在vip_subnet_cidr_id的子网网段中。

• vip_subnet_cidr_id对应的子网必须属于当前负载均衡器vpc_id对应的VPC。

• 只有guaranteed是true的负载均衡器才支持更新vip_subnet_cidr_id。

• 传入null表示解绑IPv4子网。

• 更新IPv6子网不会导致IPv4子网发生变化。

vip_address

否

String

参数解释：负载均衡器的IPv4虚拟IP。

约束限制：该地址必须包含在所在子网的IPv4网段内，且未被占用。

注：仅当guaranteed是true的场合，才支持更新。

l4_flavor_id

否

String

参数解释：网络型规格ID。

约束限制：

• 可以通过GET https://{ELB_Endpoint}/v3/{project_id}/elb/flavors?type=L4 响应参数中的id得到。

• 仅当guaranteed是true的场合，才支持更新。

• 可以支持规格改大改小，注意改小过程中可能会造成部分长连接中断，影响部分链接的新建，

• autoscaling.enable=true时，修改无意义，不生效。

• 当传入的规格类型为L4，表示该实例为固定规格实例，按规格计费。

• 当传入的规格类型为L4_elastic_max，表示该实例为弹性实例，按LCU计费。

l7_flavor_id

否

String

参数解释：应用型ID。

约束限制：

• 可以通过GET https://{ELB_Endpoint}/v3/{project_id}/elb/flavors?type=L7 响应参数中的id得到。

• 仅当guaranteed是true的场合，才支持更新。

• 可以支持规格改大改小，注意改小过程中可能会造成部分长连接中断，影响部分链接的新建，

• autoscaling.enable=true时，修改无意义，不生效。

• 当传入的规格类型为L7，表示该实例为固定规格实例，按规格计费。

• 当传入的规格类型为L7_elastic_max，表示该实例为弹性实例，按LCU计费。

ipv6_bandwidth

否

BandwidthRef object

参数解释：带宽对象ID。

约束限制：

• 仅在创建或更新公网IPv6负载均衡器时有效。

• 若选择创建新EIP并指定共享带宽时，此EIP会被分进共享带宽里面。

ip_target_enable

否

Boolean

参数解释：是否启用跨VPC后端转发。

开启跨VPC后端转发后，后端服务器组不仅支持添加云上VPC内的服务器，还支持添加其他VPC、其他公有云、云下数据中心的服务器。

约束限制：

• 开启后不能关闭。

• 使用共享VPC的实例使用此特性时，需确保共享资源所有者已开通VPC对等连接，否则通信异常。

• 仅独享型负载均衡器支持该特性。

取值范围：

• true：开启。

• false：不开启。

elb_virsubnet_ids

否

Array of strings

参数解释：下联面子网的网络ID列表。

可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。

约束限制：

• 已绑定的下联面子网也在传参elb_virsubnet_ids列表中，则绑定关系保留。

• 已绑定的下联面子网若不在传参elb_virsubnet_ids列表中，

  则将移除LB与该下联面子网的关联关系。但不允许移除已被ELB使用的子网，否则将报错，不做任何修改。

• 在传参elb_virsubnet_ids列表中但不在已绑定的下联面子网列表中，则将新增LB与下联面的绑定关系。

• 所有elb_virsubnet_ids中的ID同属于该LB所在的VPC。

• 不支持边缘云子网。

deletion_protection_enable

否

Boolean

参数解释：是否开启删除保护。

约束限制：退场时需要先关闭所有资源的删除保护开关。

取值范围：false不开启，true开启。

autoscaling

否

UpdateLoadbalancerAutoscalingOption object

参数解释：弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后，可根据负载情况自动调整负载均衡器的规格。

约束限制：

• 仅当项目白名单放开后该字段才有效

• 开启弹性扩缩容后，l4_flavor_id和l7_flavor_id表示该LB实例弹性规格的上限。

ipv6_vip_address

否

String

参数解释：双栈类型负载均衡器的IPv6地址。

id

是

String

参数解释：共享带宽的ID。

enable

是

Boolean

参数解释：当前负载均衡器是否开启弹性扩缩容。

取值范围：

• true：开启。

• false：不开启。

min_l7_flavor_id

否

String

参数解释：弹性扩缩容的最小七层规格ID（规格类型L7_elastic）。

约束限制：有七层监听器时，该字段不能为空。

该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。

loadbalancer

LoadBalancer object

参数解释：负载均衡器对象。（包周期规格变更场景不返回该字段）

request_id

String

参数解释：请求ID。

注：自动生成 。

id

String

参数解释：负载均衡器ID。

description

String

参数解释：负载均衡器描述信息。

provisioning_status

String

参数解释：负载均衡器的配置状态。

取值范围：

• ACTIVE：使用中。

• PENDING_DELETE：删除中。

admin_state_up

Boolean

参数解释：负载均衡器的启用状态。

取值范围：

• true ：启用。

• false：停用。

provider

String

参数解释：负载均衡器的生产者名称。固定为vlb。

pools

Array of PoolRef objects

参数解释：负载均衡器直接关联的后端服务器组的ID列表。

listeners

Array of ListenerRef objects

参数解释：负载均衡器关联的监听器的ID列表。

operating_status

String

参数解释：负载均衡器的操作状态。

取值范围：

• ONLINE：在线。

• FROZEN：已冻结。

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。

取值范围：

• false：共享型。

• true：独享型。

vpc_id

String

参数解释：负载均衡器所在VPC ID。

eips

Array of EipInfo objects

参数解释：负载均衡器绑定的EIP。

约束限制：只支持绑定一个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。创建时不传则返回"0"，表示资源属于default企业项目。

注意："0"并不是真实存在的企业项目ID，在创建、更新和查询时不能作为请求参数传入。

billing_info

String

参数解释：资源账单信息。

取值范围：

• 空：按需计费。

• 非空：包周期计费，格式为：order_id:product_id:region_id:project_id。如：CS2107161019CDJZZ:OFFI569702121789763584:az1:057ef081eb00d2732fd1c01a9be75e6f

l4_flavor_id

String

参数解释：网络型规格ID。

对于弹性扩缩容实例，表示上限规格。

约束限制：

• 当传入的规格类型为L4，表示该实例为固定规格实例，按规格计费；

• 当传入的规格类型为L4_elastic_max，表示该实例为弹性实例，按LCU计费

l4_scale_flavor_id

String

参数解释：四层弹性Flavor ID。

不支持该字段，请勿使用。

l7_flavor_id

String

参数解释：应用型ID。

对于弹性扩缩容实例，表示上限规格ID。

约束限制：

• 当传入的规格类型为L7，表示该实例为固定规格实例，按规格计费；

• 当传入的规格类型为L7_elastic_max，表示该实例为弹性实例，按LCU计费

l7_scale_flavor_id

String

参数解释：七层弹性Flavor ID。

不支持该字段，请勿使用。

publicips

Array of PublicIpInfo objects

参数解释：负载均衡器绑定的公网IP。只支持绑定一个公网IP。

注：该字段与eips一致。

global_eips

Array of GlobalEipInfo objects

参数解释：负载均衡器绑定的global eip。

约束限制：只支持绑定一个globaleip。

elb_virsubnet_ids

Array of strings

参数解释：下联面子网的网络ID列表。

elb_virsubnet_type

String

参数解释：下联面子网类型。

取值范围：

• ipv4：ipv4

• dualstack：双栈

ip_target_enable

Boolean

参数解释：是否启用跨VPC后端转发。

开启跨VPC后端转发后，后端服务器组不仅支持添加云上VPC内的服务器，还支持添加其他VPC、其他公有云、云下数据中心的服务器。

约束限制：

• 开启后不能关闭。

• 使用共享VPC的实例使用此特性时，需确保共享资源所有者已开通VPC对等连接，否则通信异常。

• 仅独享型负载均衡器支持该特性。

取值范围：

• true：开启。

• false：不开启。

frozen_scene

String

参数解释：负载均衡器的冻结场景。

若负载均衡器有多个冻结场景，用逗号分隔。

取值范围：

• POLICE：公安冻结场景。

• ILLEGAL：违规冻结场景。

• VERIFY：客户未实名认证冻结场景。

• PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。

• AREAR：欠费冻结场景。

ipv6_bandwidth

BandwidthRef object

参数解释：带宽对象ID。

约束限制：

• 仅在创建或更新公网IPv6负载均衡器时有效。

• 若选择创建新EIP并指定共享带宽时，此EIP会被分进共享带宽里面。

deletion_protection_enable

Boolean

参数解释：是否开启删除保护。

约束限制：

• 仅当前局点启用删除保护特性后才会返回该字段。

• 退场时需要先关闭所有资源的删除保护开关。

取值范围：

• false：不开启。

• true：开启。

autoscaling

AutoscalingRef object

参数解释：弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后，可根据负载情况自动调整负载均衡器的规格。

约束限制：

• 仅当项目白名单放开后该字段才有效

• 开启弹性扩缩容后，l4_flavor_id和l7_flavor_id表示该LB实例弹性规格的上限。

public_border_group

String

参数解释：LB所属AZ组。

waf_failure_action

String

参数解释：WAF故障时的流量处理策略。

约束限制：只有绑定了waf的LB实例，该字段才会生效。

取值范围：discard:丢弃，forward: 转发到后端。

默认取值：forward

id

String

参数解释：后端服务器组ID。

id

String

参数解释：监听器ID。

key

String

参数解释：标签键

value

String

参数解释：标签值

eip_id

String

参数解释：弹性IP的ID。

eip_address

String

参数解释：弹性IP的IP地址。

ip_version

Integer

参数解释：IP版本号。

取值范围：

• 4表示IPv4。

• 6表示IPv6。

publicip_id

String

参数解释：弹性公网ip配置id

publicip_address

String

参数解释：IP地址

ip_version

Integer

参数解释：IP版本信息。

取值范围：4和6 4：IPv4 6：IPv6

global_eip_id

String

参数解释：global eip的id

global_eip_address

String

参数解释：global eip的ip地址

ip_version

Integer

参数解释：IP版本信息。

取值范围：

• 4，表示IPv4

• 6，表示IPv6

id

String

参数解释：共享带宽的ID。

enable

Boolean

参数解释：当前负载均衡器是否开启弹性扩缩容。

取值范围：

• true：开启。

• false：不开启。

默认取值：false

min_l7_flavor_id

String

参数解释：弹性扩缩容的最小七层规格ID（规格类型L7_elastic）。

约束限制：有七层监听器时，该字段不能为空。

200

操作正常返回。