更新负载均衡器

功能介绍

更新负载均衡器。

调用方法

URI

PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

表1 路径参数
参数	是否必选	参数类型	描述
loadbalancer_id	是	String	参数解释：负载均衡器ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及
project_id	是	String	参数解释：项目ID。获取方式请参见获取项目ID。约束限制：不涉及取值范围：长度为32个字符，由小写字母和数字组成。默认取值：不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：IAM鉴权Token。约束限制：不涉及取值范围：不涉及默认取值：不涉及

表3 请求Body参数
参数	是否必选	参数类型	描述
loadbalancer	是	UpdateLoadBalancerOption object	参数解释：更新负载均衡器参数对象。约束限制：不涉及

表4 UpdateLoadBalancerOption
参数	是否必选	参数类型	描述
name	否	String	参数解释：负载均衡器的名称。约束限制：不涉及取值范围：支持中文字符、英文字符等unicode字符，且长度为[0-255]个字符。可以为空。默认取值：不涉及
admin_state_up	否	Boolean	参数解释：负载均衡器的启用状态。取值范围： true ：启用。 false：停用。约束限制：不涉及取值范围：不涉及默认取值：不涉及
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子网发生变化。约束限制： ipv6_vip_virsubnet_id 对应的子网必须属于当前负载均衡器所在VPC，且子网需开启支持IPv6。只有guaranteed是true的负载均衡器才支持更新ipv6_vip_virsubnet_id。取值范围：标准的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子网发生变化。约束限制：若同时设置了vip_address，则必须保证vip_address对应的IP在vip_subnet_cidr_id的子网网段中。 vip_subnet_cidr_id对应的子网必须属于当前负载均衡器vpc_id对应的VPC。只有guaranteed是true的负载均衡器才支持更新vip_subnet_cidr_id。取值范围：标准的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得到。约束限制：仅当guaranteed是true的场合，才支持更新。可以支持规格改大改小，注意改小过程中可能会造成部分长连接中断，影响部分连接的新建。 autoscaling.enable=true时，修改无意义，不生效。当传入的规格类型为L4，表示该实例为固定规格实例，按规格计费。当传入的规格类型为L4_elastic_max，表示该实例为弹性实例，按LCU计费。网关型LB不支持指定l4_flavor_id。取值范围：不涉及默认取值：不涉及
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计费。网关型LB不支持指定l7_flavor_id。取值范围：不涉及默认取值：不涉及
ipv6_bandwidth	否	BandwidthRef object	参数解释：带宽对象ID。约束限制：仅在创建或更新公网负载均衡器时有效。若选择创建新EIP并指定共享带宽时，此EIP会被分进共享带宽里面。
ip_target_enable	否	Boolean	参数解释：是否启用IP类型后端转发。约束限制：开启IP类型后端，ELB需要占用后端子网中的IP地址与后端服务器进行通信，请确保预留足够的IP地址。使用共享VPC的实例使用此特性时，需确保共享资源所有者已开通VPC对等连接，否则通信异常。网关型LB不支持该特性。取值范围： 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地址。约束限制：不涉及取值范围：不涉及默认取值：不涉及

表5 BandwidthRef
参数	是否必选	参数类型	描述
id	是	String	参数解释：共享带宽的ID。

表6 UpdateLoadbalancerAutoscalingOption
参数	是否必选	参数类型	描述
enable	是	Boolean	参数解释：当前负载均衡器是否开启弹性扩缩容。约束限制：不涉及取值范围： true：开启。 false：不开启。默认取值：不涉及
min_l7_flavor_id	否	String	参数解释：弹性扩缩容的最小七层规格ID（规格类型L7_elastic）。约束限制：有七层监听器时，该字段不能为空。取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表7 响应Body参数
参数	参数类型	描述
loadbalancer	LoadBalancer object	参数解释：负载均衡器对象。
request_id	String	参数解释：请求ID。取值范围：由数字、小写字母和中划线（-）组成的字符串，自动生成。

表8 LoadBalancer
参数	参数类型	描述
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。说明：该字段与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企业项目。 UUID格式的字符串，表示非默认企业项目。
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	参数解释：负载均衡器类别。取值范围： gateway 表示网关类型负载均衡器。 null 表示其他非网关类型负载均衡器。不支持该字段，请勿使用。
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	参数解释：下联面子网类型。取值范围： ipv4：仅支持IPv4 dualstack：双栈，同时支持IPv4和IPv6。
ip_target_enable	Boolean	参数解释：是否启用IP类型后端转发。取值范围： true：开启。 false：不开启。
frozen_scene	String	参数解释：负载均衡器的冻结场景。若负载均衡器有多个冻结场景，用逗号分隔。取值范围： ILLEGAL：违规冻结场景。 VERIFY：客户未实名认证冻结场景。 PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。 ARREAR：欠费冻结场景。
deletion_protection_enable	Boolean	参数解释：是否开启删除保护。仅当前局点启用删除保护特性后才会返回该字段。取值范围： false：不开启。 true：开启。
autoscaling	AutoscalingRef object	参数解释：弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后，可根据负载情况自动调整负载均衡器的规格。说明：该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。
public_border_group	String	参数解释：公网边界组。取值范围： center：表示中心站点的公网边界组边缘站点名称：表示边缘站点的公网边界组不支持该字段，请勿使用。
charge_mode	String	参数解释：负载均衡器实例的计费模式。取值范围： flavor：按规格计费。 lcu：按使用量计费。空值：若是共享型表示免费实例。若是独享型则与flavor模式一致，都是按规格计费。不支持该字段，请勿使用。
service_lb_mode	String	参数解释：LB模式。取值范围： lb：默认模式，不支持跨租户访问。 ep：ep模式，LB支持跨租户访问。不支持该字段，请勿使用。
instance_type	String	参数解释：标识实例归属哪个内部服务。取值范围：不涉及不支持该字段，请勿使用。
instance_id	String	参数解释：标识实例绑定内部服务的实例id。取值范围：不涉及不支持该字段，请勿使用。
proxy_protocol_extensions	Array of ProxyProtocolExtension objects	参数解释：pp扩展。不支持该字段，请勿使用。
waf_failure_action	String	参数解释：WAF故障时的流量处理策略。取值范围：discard:丢弃，forward: 转发到后端。不支持该字段，请勿使用。
custom_qos_limit	CustomQosLimit object	参数解释：弹性负载均衡器的规格的自定义限速信息。不支持该字段，请勿使用。

表9 PoolRef
参数	参数类型	描述
id	String	参数解释：后端服务器组ID。取值范围：不涉及

**表10** ListenerRef
参数	参数类型	描述
id	String	参数解释：监听器ID。取值范围：不涉及

**表11** Tag
参数	参数类型	描述
key	String	参数解释：标签键。取值范围：不涉及
value	String	参数解释：标签值。取值范围：不涉及

**表12** EipInfo
参数	参数类型	描述
eip_id	String	参数解释：弹性IP的ID。取值范围：不涉及
eip_address	String	参数解释：弹性IP的IP地址。取值范围：不涉及
ip_version	Integer	参数解释：IP版本号。取值范围： 4：表示IPv4地址。 6：表示IPv6地址。

**表13** PublicIpInfo
参数	参数类型	描述
publicip_id	String	参数解释：弹性公网EIP的ID。取值范围：不涉及
publicip_address	String	参数解释：EIP的IP地址。取值范围：不涉及
ip_version	Integer	参数解释：IP版本信息。取值范围： 4：IPv4地址。 6：IPv6地址。

**表14** GlobalEipInfo
参数	参数类型	描述
global_eip_id	String	参数解释：global eip的ID。取值范围：不涉及
global_eip_address	String	参数解释：global eip的ip地址。取值范围：不涉及
ip_version	Integer	参数解释：IP版本信息。取值范围： 4，表示IPv4 6，表示IPv6

**表15** AutoscalingRef
参数	参数类型	描述
enable	Boolean	参数解释：当前负载均衡器是否开启弹性扩缩容。取值范围： true：开启。 false：不开启。
min_l7_flavor_id	String	参数解释：弹性扩缩容的最小七层规格ID（规格类型L7_elastic）。取值范围：不涉及

**表16** ProxyProtocolExtension
参数	参数类型	描述
vip_address	String	参数解释：ipv4 vip地址。约束限制：不涉及取值范围：不涉及默认取值：不涉及
ipv6_vip_address	String	参数解释：ipv6 vip地址。约束限制：不涉及取值范围：不涉及默认取值：不涉及
extension	Extension object	参数解释：pp 扩展。约束限制：不涉及

**表17** Extension
参数	参数类型	描述
ep_id	String	参数解释：EP ID. 约束限制：不涉及取值范围：不涉及默认取值：不涉及
ep_service_id	String	参数解释：EP Service ID. 约束限制：不涉及取值范围：不涉及默认取值：不涉及

**表18** CustomQosLimit
参数	参数类型	描述
l4	L4Limit object	参数解释：负载均衡实例的四层规格自定义限速信息。
l7	L7Limit object	参数解释：负载均衡实例的七层规格自定义限速信息。

**表19** L4Limit
参数	参数类型	描述
connection	Integer	参数解释：负载均衡实例的四层规格的最大并发连接数限速值。取值范围：不涉及
cps	Integer	参数解释：负载均衡实例的四层规格的每秒新建连接数限速值。取值范围：不涉及

**表20** L7Limit
参数	参数类型	描述
connection	Integer	参数解释：负载均衡实例的七层规格的最大并发连接数限速值。取值范围：不涉及
cps	Integer	参数解释：负载均衡实例的七层规格的每秒新建连接数限速值。取值范围：不涉及

请求示例

更新负载均衡器的描述和名称

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"
  }
}

状态码

状态码	描述
200	操作正常返回。

错误码

请参见错误码。

父主题：负载均衡器

上一篇：查询负载均衡器详情

下一篇：删除负载均衡器

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试