计算
弹性云服务器 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

创建负载均衡器

功能介绍

创建独享型负载均衡器,包括按需及包周期计费负载均衡器。

  • 若要创建内网IPv4负载均衡器,则需要传入vip_subnet_cidr_id。

  • 若要创建公网IPv4负载均衡器,则需要传入publicip,以及传入vpc_id和vip_subnet_cidr_id这两个参数中的一个。

  • 若要绑定有已有公网IPv4地址,则需要传入publicip_ids,以及传入vpc_id和vip_subnet_cidr_id这两个参数中的一个。

  • 若要创建内网双栈负载均衡器,则需要传入ipv6_vip_virsubnet_id。

  • 若要创建公网双栈负载均衡器,则需要传入ipv6_vip_virsubnet_id和ipv6_bandwidth。

  • 若要创建网络型负载均衡器,则需要传入l4_flavor_id(网络型规格ID);若要创建应用型负载均衡器,则需要传入l7_flavor_id(应用型规格ID);若要创建网络型+应用型负载均衡器,则需要传入l4_flavor_id和l7_flavor_id。

  • 若要创建包周期负载均衡器,则需要传入prepaid_options,否则创建按需计费负载均衡器。

  • 按需计费分为固定规格计费和弹性规格计费,根据创建时所选规格的类型决定计费方式。具体规格说明见创建LB请求参数l4_flavor_id和l7_flavor_id。

接口约束

  • vpc_id 或 vip_subnet_cidr_id 或 ipv6_vip_virsubnet_id 不能同时为空。

  • ip_target_enable参数表示是否启用跨VPC后端转发能力,

    启用跨VPC后端转发的负载均衡器关联的member和VIP可以在不同VPC下,

    未启用跨VPC后端转发的负载均衡器关联的member和VIP必须在同一个VPC下。

  • admin_state_up参数的值必须是true。

  • provider参数的值必须是vlb。

  • elb_virsubnet_ids参数对应的网络类型支持双栈或者只支持ipv4。

    网络类型为只支持ipv4时,ipv6_vip_virsubnet_id参数需要为空。

  • 只能通过ELB Console控制台来解绑EIP,

    在ELB列表查询页面选择操作列中的更多按钮->解绑EIP。

  • 创建LB时不能同时设置publicip_ids和publicip,

    只能选择绑定已有公网IP或者选择新建公网IP,或者都不设置这两个字段。

  • 若要绑定已有带宽,则需要设置共享带宽ID,不支持绑定独享带宽。

    若需要新建独享带宽,则带宽信息中charge_mode、share_type和size字段是必须的。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/elb/loadbalancers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:负载均衡器的项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:IAM鉴权Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

loadbalancer

CreateLoadBalancerOption object

参数解释:创建负载均衡器实例的参数对象。

表4 CreateLoadBalancerOption

参数

是否必选

参数类型

描述

project_id

String

参数解释:负载均衡器实例所在的项目ID。

name

String

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

约束限制: 可以为空, 最大长度为255个字符。

取值范围:支持中文字符、英文字符等unicode字符,且长度为[0-255]个字符。

description

String

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

约束限制: 可以为空, 最大长度为255个字符。

取值范围:支持中文字符、英文字符等unicode字符,且长度为[0-255]个字符。

vip_address

String

参数解释:负载均衡器的IPv4私网IP。该地址必须包含在所在子网的IPv4网段内,且未被占用。

约束限制:

  • 传入vip_address时,必须传入vip_subnet_cidr_id。

  • 不传入vip_address,但传入vip_subnet_cidr_id,则自动分配IPv4私网IP。

  • 不传入vip_address,且不传vip_subnet_cidr_id,则不分配IPv4私网IP,vip_address=null。

取值范围:满足IPv4的地址格式,[0-255].[0-255].[0-255].[0-255]. 如192.168.1.1。

vip_subnet_cidr_id

String

参数解释:负载均衡器所在子网的IPv4子网ID,也称为该负载均衡器实例的前端子网。

约束限制:

  • 若创建带有IPv4私网IP的负载均衡实例,则字段必须传入。可以通过调用VPC的API, GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_subnet_id得到。

  • vpc_id, vip_subnet_cidr_id, ipv6_vip_virsubnet_id不能同时为空,且需要在同一个vpc下。

  • 若同时传入vpc_id和vip_subnet_cidr_id,则vip_subnet_cidr_id对应的子网必须属于vpc_id对应的VPC。

取值范围:标准的UUID格式,长度为36个字符。

ipv6_vip_virsubnet_id

String

参数解释:双栈类型负载均衡器所在子网的IPv6网络ID,也称为该负载均衡器实例的前端子网。

约束限制:

  • 若创建带有IPv6 IP的负载均衡实例,则字段必须传入。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。

  • vpc_id,vip_subnet_cidr_id,ipv6_vip_virsubnet_id不能同时为空,且需要在同一个vpc下。

  • 需要对应的子网开启IPv6。

取值范围:标准的UUID格式,长度为36个字符。

provider

String

参数解释:负载均衡器的生产者名称。固定为vlb,无需指定。

l4_flavor_id

String

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

约束限制:

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

  • 当l4_flavor_id和l7_flavor_id都不传的时,会使用默认flavor(默认flavor根据不同局点有所不同,具体以实际值为准)。

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

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

取值范围:标准的UUID格式,长度为36个字符。

l7_flavor_id

String

参数解释:应用型规格ID。

约束限制:

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

  • 当l4_flavor_id和l7_flavor_id都不传的时,会使用默认flavor

    (默认flavor根据不同局点有所不同,具体以实际值为准)。

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

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

取值范围:标准的UUID格式,长度为36个字符。

guaranteed

Boolean

参数解释:是否为独享型负载均衡器实例。

约束限制:当前只支持设置为true,设置为false会返回400 Bad Request。

取值范围:

  • true:独享型。

  • false:共享型。

默认取值:true。

vpc_id

String

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

约束限制:

  • 参数获取,可以通过 GET https://{VPC_Endpoint}/v1/{project_id}/vpcs 响应参数中的id得到。

  • vpc_id,vip_subnet_cidr_id,ipv6_vip_virsubnet_id不能同时为空,且需要在同一个vpc下。

取值范围:标准的UUID格式,长度为36个字符。

availability_zone_list

Array of strings

参数解释:负载均衡器实例所在的可用区列表。

约束限制:

  • 可通过GET https://{ELB_Endpoint}/v3/{project_id}/elb/availability-zones 接口来查询可用区集合列表。创建负载均衡器时,从查询结果选择某一个可用区集合,并从中选择一个或多个可用区。

说明:

为了支持可用区容灾,建议选取不少于2个可用区。

enterprise_project_id

String

参数解释:负载均衡器所属的企业项目ID。

约束限制:不能传入""、"0"或不存在的企业项目ID,创建时不传则资源属于default企业项目,默认返回"0"。

tags

Array of Tag objects

参数解释:负载均衡的标签列表。示例:"tags":[{"key":"my_tag","value":"my_tag_value"}]

admin_state_up

Boolean

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

取值范围:

  • true :启用。

  • false:停用。

默认取值:true。

ipv6_bandwidth

BandwidthRef object

参数解释:带宽对象ID。

约束限制:

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

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

publicip_ids

Array of strings

参数解释:负载均衡器绑定的公网IP的ID的数组。

约束限制:

  • 只支持绑定数组中的第一个EIP,其他将被忽略。

publicip

CreateLoadBalancerPublicIpOption object

参数解释:创建ELB时,新建公网IP请求参数

elb_virsubnet_ids

Array of strings

参数解释:负载均衡器的后端子网的网络ID(OpenStack Neutron接口)列表。负载均衡器实例会预占用该子网中的部分IP, 用于负载均衡器网关与该实例后端服务器通信的源地址(典型场景,健康检查探测的源地址,FULLNAT场景的源地址等)。

使用负载均衡器所在VPC的ID查询可用子网

GET https://{VPC_Endpoint}/v1/{project_id}/subnets?vpc_id=xxxx 获取响应参数中的neutron_network_id字段。

约束限制:

  • 后端子网必须属于该负载均衡器实例所在的VPC。

  • 通常需要用户指定一个特殊的子网,方便用户在后端服务器关联的安全组中,放通该子网的地址段。

  • 若指定多个下联面子网,则按顺序优先使用第一个子网来为负载均衡器下联面端口分配ip地址。

  • 若不指定该字段,则按如下规则选择下联面网络:

    1. 如果ELB实例开启ipv6,则选择ipv6_vip_virsubnet_id子网对应的网络ID。

    2. 如果ELB实例没有开启ipv6,开启ipv4,则选择vip_subnet_cidr_id子网对应的网络ID。

    3. 如果ELB实例没有选择私网,只开启公网,则会在当前负载均衡器所在的VPC中任意选一个子网,优选可用IP多的网络。

  • 后端服务器安全组放通:由于负载均衡器网关会使用该子网中的预占的地址,作为源IP与后端服务器通信(健康检查探测,FULLNAT通信),为避免后端服务器关联的安全组拦截,建议将对应的子网地址段进行安全组放通。

  • 预占地址变化:负载均衡实例,弹性扩缩场景,可能涉及到预占地址的变化,建议安全组对子网段放通,而不是具体预占地址的放通。

  • 建议后端子网,使用一个独占的地址充足的子网,方便运维管理。

ip_target_enable

Boolean

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

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

约束限制:

  • 开启后不能关闭。

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

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

取值范围:

  • true:开启。

  • false:不开启。

deletion_protection_enable

Boolean

参数解释:实例删除保护开关。

约束限制:实例删除前,需要先关闭该实例下所有资源的删除保护开关。

取值范围:

  • false: 不开启。

  • true: 开启。

默认取值:false。

autoscaling

CreateLoadbalancerAutoscalingOption object

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

约束限制:

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

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

说明:

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

ipv6_vip_address

String

参数解释:负载均衡器实例的IPv6地址。

约束限制:

  • 必须属于ipv6_vip_virsubnet_id子网中地址。

  • elb_virsubnet_ids中的后端子网必须支持双栈。

表5 Tag

参数

是否必选

参数类型

描述

key

String

参数解释:标签键

value

String

参数解释:标签值

表6 BandwidthRef

参数

是否必选

参数类型

描述

id

String

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

表7 CreateLoadBalancerPublicIpOption

参数

是否必选

参数类型

描述

ip_version

Integer

参数解释:IP版本。

约束限制:取值只有4和6。4:IPv4, 6: IPv6。

取值范围:

  • 4:表示IPv4。

  • 6:表示IPv6。

默认取值:4

network_type

String

参数解释:弹性公网IP的网络类型,默认5_bgp,更多请参考弹性公网ip创建。

约束限制:华南-深圳局点该参数取值只能为5_gray。

取值范围:5_bgp。

默认取值:5_bgp。

billing_info

String

参数解释:计费订单信息。

约束限制:

  • 空:按需计费。

  • 非空:包周期计费。格式:order_id:product_id:region_id:project_id

description

String

参数解释:弹性公网IP的描述信息。

bandwidth

CreateLoadBalancerBandwidthOption object

参数解释:带宽信息

表8 CreateLoadBalancerBandwidthOption

参数

是否必选

参数类型

描述

name

String

参数解释:带宽名称。

约束限制:

  • 如果share_type是PER,该字段是必选。

  • 如果bandwidth对象的id有值,该字段被忽略。

取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

size

Integer

参数解释:带宽大小。

约束限制:当id字段为null时,size是必须的。

注意,调整带宽时的最小单位会根据带宽范围不同存在差异。

  • 小于等于300Mbit/s: 默认最小单位为1Mbit/s。

  • 300Mbit/s~1000Mbit/s: 默认最小单位为50Mbit/s。

  • 大于1000Mbit/s: 默认最小单位为500Mbit/s。

取值范围:默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。

charge_mode

String

参数解释:计费模式。bandwidth 按带宽计费;traffic 按流量计费。

约束限制:当id字段为null时,charge_mode是必须的。

取值范围:

  • bandwidth:按带宽计费。

  • traffic: 按流量计费。

share_type

String

参数解释:带宽类型。

约束限制:

  • 当id字段为null时,share_type是必须的。当id不为null时,该字段被忽略。

  • 该字段为WHOLE时,必须指定带宽ID。

  • IPv6的EIP不支持WHOLE类型带宽。

取值范围:

  • PER:独享带宽。

  • WHOLE:共享带宽。

billing_info

String

参数解释:资源计费信息。

约束限制:

如果billing_info不为空,说明是包周期计费的带宽,否则为按需计费的带宽。

id

String

参数解释:共享带宽ID。使用已存在的共享带宽。

约束限制:必须是已存在共享带宽ID。在预付费的情况下,不填该字段。该字段取空字符串时,会被忽略。

表9 CreateLoadbalancerAutoscalingOption

参数

是否必选

参数类型

描述

enable

Boolean

参数解释:负载均衡器实例弹性扩缩容开关。

取值范围:

  • true:开启。

  • false:关闭。

min_l7_flavor_id

String

参数解释:实例弹性扩缩容的最小七层规格ID。

约束限制: 该字段已经废弃,建议不要使用该字段。

响应参数

状态码:201

表10 响应Body参数

参数

参数类型

描述

loadbalancer

LoadBalancer object

参数解释:负载均衡器对象。(包周期场景不返回该字段)

request_id

String

参数解释:请求ID。

注:自动生成 。

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

表12 PoolRef

参数

参数类型

描述

id

String

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

表13 ListenerRef

参数

参数类型

描述

id

String

参数解释:监听器ID。

表14 Tag

参数

参数类型

描述

key

String

参数解释:标签键

value

String

参数解释:标签值

表15 EipInfo

参数

参数类型

描述

eip_id

String

参数解释:弹性IP的ID。

eip_address

String

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

ip_version

Integer

参数解释:IP版本号。

取值范围:

  • 4表示IPv4。

  • 6表示IPv6。

表16 PublicIpInfo

参数

参数类型

描述

publicip_id

String

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

publicip_address

String

参数解释:IP地址

ip_version

Integer

参数解释:IP版本信息。

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

表17 GlobalEipInfo

参数

参数类型

描述

global_eip_id

String

参数解释:global eip的id

global_eip_address

String

参数解释:global eip的ip地址

ip_version

Integer

参数解释:IP版本信息。

取值范围:

  • 4,表示IPv4

  • 6,表示IPv6

表18 BandwidthRef

参数

参数类型

描述

id

String

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

表19 AutoscalingRef

参数

参数类型

描述

enable

Boolean

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

取值范围:

  • true:开启。

  • false:不开启。

默认取值:false

min_l7_flavor_id

String

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

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

说明:

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

请求示例

  • 示例1 : 创建一个私网IPv4负载均衡器

    POST https://{ELB_Endpoint}/v3/060576798a80d5762fafc01a9b5eedc7/elb/loadbalancers
    
    {
      "loadbalancer" : {
        "name" : "loadbalancer",
        "description" : "simple lb",
        "vip_subnet_cidr_id" : "1992ec06-f364-4ae3-b936-6a8cc24633b7",
        "admin_state_up" : true,
        "availability_zone_list" : [ "AZ1" ]
      }
    }
  • 示例2 : 创建公网IPv4负载均衡器

    POST https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
    
    {
      "loadbalancer" : {
        "vip_subnet_cidr_id" : "e6e9271d-aef4-48f0-a93a-ccc7b09032c1",
        "availability_zone_list" : [ "AZ1" ],
        "admin_state_up" : true,
        "publicip" : {
          "network_type" : "5_bgp",
          "bandwidth" : {
            "size" : 2,
            "share_type" : "PER",
            "charge_mode" : "bandwidth",
            "name" : "bandwidth_test"
          }
        },
        "name" : "elb_eip-test"
      }
    }

响应示例

状态码:201

POST操作正常返回。

{
  "loadbalancer" : {
    "name" : "my_loadbalancer",
    "id" : "29cc669b-3ac8-4498-9094-bdf6193425c2",
    "project_id" : "060576798a80d5762fafc01a9b5eedc7",
    "description" : "",
    "vip_port_id" : "98697944-0cc7-4d3b-a829-001c2fb82232",
    "vip_address" : "192.168.0.214",
    "admin_state_up" : true,
    "provisioning_status" : "ACTIVE",
    "operating_status" : "ONLINE",
    "listeners" : [ ],
    "pools" : [ ],
    "tags" : [ {
      "key" : "tab_key",
      "value" : "tag1"
    } ],
    "provider" : "vlb",
    "created_at" : "2023-03-22T07:59:57Z",
    "updated_at" : "2023-03-22T07:59:59Z",
    "vpc_id" : "a1f33a4c-95b9-48a7-9350-684e2ed844b3",
    "enterprise_project_id" : "134f2181-5720-47e7-bd78-1356ed3737d6",
    "availability_zone_list" : [ ],
    "ipv6_vip_address" : null,
    "ipv6_vip_virsubnet_id" : null,
    "ipv6_vip_port_id" : null,
    "publicips" : [ {
      "publicip_id" : "3388574a-4f6f-4471-869e-97d74d21eee9",
      "publicip_address" : "88.88.87.205",
      "ip_version" : 4
    } ],
    "global_eips" : [ ],
    "elb_virsubnet_ids" : [ ],
    "elb_virsubnet_type" : null,
    "ip_target_enable" : false,
    "autoscaling" : {
      "enable" : false,
      "min_l7_flavor_id" : ""
    },
    "frozen_scene" : null,
    "public_border_group" : "center",
    "eips" : [ {
      "eip_id" : "3388574a-4f6f-4471-869e-97d74d21eee9",
      "eip_address" : "88.88.87.205",
      "ip_version" : 4
    } ],
    "guaranteed" : false,
    "billing_info" : null,
    "l4_flavor_id" : null,
    "l4_scale_flavor_id" : null,
    "l7_flavor_id" : null,
    "l7_scale_flavor_id" : null,
    "waf_failure_action" : "",
    "vip_subnet_cidr_id" : "abf31f3b-706e-4e55-a6dc-f2fcc707fd3a"
  },
  "request_id" : "bf29597181cb81b30d19f1a0115a157d"
}

状态码

状态码

描述

201

POST操作正常返回。

错误码

请参见错误码

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

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容