更新负载均衡器

loadbalancer_id

是

String

负载均衡器ID。

最小长度：0

最大长度：36

project_id

是

String

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

最小长度：0

最大长度：36

X-Auth-Token

是

String

IAM鉴权Token。

最小长度：0

最大长度：4096

loadbalancer

是

UpdateLoadBalancerOption object

负载均衡器对象。

name

否

String

负载均衡器的名称。

最小长度：0

最大长度：255

admin_state_up

否

Boolean

负载均衡器的启用状态，true表示启用，false表示停用。只能设置为true。

description

否

String

负载均衡器的描述。

最小长度：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地址将发生变化。

使用说明：

• 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子网。

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

最小长度：1

最大长度：36

vip_address

否

String

负载均衡器的IPv4虚拟IP。该地址必须包含在所在子网的IPv4网段内，且未被占用。

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

最小长度：1

最大长度：36

l4_flavor_id

否

String

网络型规格ID。

使用说明：

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

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

• 不允许非null变成null，null变成非null，即不配置七层规格和配置七层规格之间不允许切换；

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

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

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

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

最小长度：1

最大长度：255

l7_flavor_id

否

String

应用型ID。

使用说明：

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

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

• 不允许非null变成null，null变成非null，即不配置七层规格和配置七层规格之间不允许切换；

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

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

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

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

最小长度：1

最大长度：36

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与下联面的绑定关系。

使用说明：

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

• 不支持边缘云子网。

最小长度：1

最大长度：64

数组长度：0 - 64

deletion_protection_enable

否

Boolean

是否开启删除保护。

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

autoscaling

否

UpdateLoadbalancerAutoscalingOption object

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

使用说明：

• 仅当租户白名单放开后该字段才有效

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

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

ipv6_vip_address

否

String

双栈类型负载均衡器的IPv6地址。

id

是

String

共享带宽的id

auto_pay

否

Boolean

下单订购后，是否自动从客户的账户中支付； true：自动支付； false：不自动支付（默认）。 自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。

缺省值：false

change_mode

否

String

规格变更类型： immediate：即时变更，规格变更立即生效。（默认） delay：续费变更，当前周期结束后变更为目标规格。

缺省值：immediate

最小长度：0

最大长度：10

period_num

否

Integer

订购周期数（默认1），取值会随运营策略变化。（仅在change_mode为delay时生效） period_type为month时，为[1,9]， period_type为year时，为[1,3]

最小值：1

最大值：9

缺省值：1

period_type

否

String

订购周期类型，当前支持包月和包年： （仅在change_mode为delay时生效） month：月（默认）； year：年；

缺省值：month

enable

是

Boolean

当前负载均衡器是否开启弹性扩缩容。

取值：

• true：开启。

• false：不开启。

缺省值：false

min_l7_flavor_id

否

String

弹性扩缩容的最小七层规格ID（规格类型L7_elastic），有七层监听器时，该字段不能为空。

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

最小长度：1

最大长度：36

loadbalancer

LoadBalancer object

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

loadbalancer_id

String

负载均衡器的id

最小长度：0

最大长度：36

order_id

String

订单号

最小长度：0

最大长度：36

request_id

String

请求ID。

注：自动生成 。

最小长度：0

最大长度：36

id

String

负载均衡器ID。

description

String

负载均衡器描述信息。

最小长度：1

最大长度：255

provisioning_status

String

负载均衡器的配置状态。

取值：

• ACTIVE：使用中。

• PENDING_DELETE：删除中。

admin_state_up

Boolean

负载均衡器的启用状态。取值：false停用，true启用。

provider

String

负载均衡器的生产者名称。固定为vlb。

pools

Array of PoolRef objects

负载均衡器直接关联的后端云服务器组的ID列表。

listeners

Array of ListenerRef objects

负载均衡器关联的监听器的ID列表。

operating_status

String

负载均衡器的操作状态。

取值：

• ONLINE：在线。

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

资源账单信息。

取值：

• 空：按需计费。

最小长度：1

最大长度：1024

l4_flavor_id

String

网络型规格ID。

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

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

最小长度：1

最大长度：255

l4_scale_flavor_id

String

四层弹性Flavor ID。

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

最小长度：1

最大长度：255

l7_flavor_id

String

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

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

最小长度：1

最大长度：255

l7_scale_flavor_id

String

七层弹性Flavor ID。

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

最小长度：1

最大长度：255

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组

charge_mode

String

收费模式。取值：

• flavor：按规格计费

• lcu：按使用量计费

waf_failure_action

String

WAF故障时的流量处理策略。discard:丢弃，forward: 转发到后端（默认）

使用说明：只有绑定了waf的LB实例，该字段才会生效。

log_group_id

String

LB所绑定的logtank对应的group id

log_topic_id

String

LB所绑定的logtank对应的topic id

id

String

后端服务器组ID。

id

String

监听器ID。

key

String

标签键

最小长度：1

最大长度：36

value

String

标签值

最小长度：0

最大长度：43

eip_id

String

eip_id

eip_address

String

eip_address

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和6 4：IPv4 6：IPv6

id

String

共享带宽的id

enable

Boolean

当前负载均衡器是否开启弹性扩缩容。

取值：

• true：开启。

• false：不开启，默认值。

min_l7_flavor_id

String

弹性扩缩容的最小七层规格ID（规格类型L7_elastic），有七层监听器时，该字段不能为空。

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

最小长度：1

最大长度：36

200

操作正常返回。