计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

更新负载均衡器

功能介绍

更新负载均衡器。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

loadbalancer_id

String

负载均衡器ID。

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:IAM鉴权Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

loadbalancer

UpdateLoadBalancerOption object

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

表4 UpdateLoadBalancerOption

参数

是否必选

参数类型

描述

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地址。

表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。

约束限制:只支持绑定一个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

表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

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

publicip_address

String

参数解释:IP地址

ip_version

Integer

参数解释:IP版本信息。

取值范围:4和6 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 BandwidthRef

参数

参数类型

描述

id

String

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

表16 AutoscalingRef

参数

参数类型

描述

enable

Boolean

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

取值范围:

  • true:开启。

  • false:不开启。

默认取值:false

min_l7_flavor_id

String

参数解释:弹性扩缩容的最小七层规格ID(规格类型L7_elastic)。

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

说明:

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

请求示例

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

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

操作正常返回。

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容