文档首页/ 弹性负载均衡 ELB/ API参考/ API（V3）/ 负载均衡器/ 创建负载均衡器
更新时间：2024-09-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建负载均衡器

功能介绍

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

  1. 若要创建内网IPv4负载均衡器，则需要传入vip_subnet_cidr_id。

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

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

  4. 若要创建内网双栈负载均衡器，则需要传入ipv6_vip_virsubnet_id。

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

  6. 若要创建网络型负载均衡器，则需要传入l4_flavor_id（网络型规格ID）；若要创建应用型负载均衡器，则需要传入l7_flavor_id（应用型规格ID）；若要创建网络型+应用型负载均衡器，则需要传入l4_flavor_id和l7_flavor_id。

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

  8. 按需计费分为固定规格计费和弹性规格计费，根据创建时所选规格的类型决定计费方式。具体规格说明见创建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_Endponit}/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。

billing_info

否

String

参数解释: 预付费实例的订单信息。

取值范围：

  • 空：按需计费。

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。

prepaid_options

否

PrepaidCreateOption object

参数解释：创建负载均衡器实例的预付费计费配置。若传入该结构体，则创建预付费类型的负载均衡器实例。

autoscaling

否

CreateLoadbalancerAutoscalingOption object

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

约束限制：

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

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

说明：

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

waf_failure_action

否

String

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

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

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

取值范围：

  • discard:丢弃。

  • forward: 转发到后端。

默认取值：forward。

protection_status

否

String

参数解释：修改保护状态。用于console控制台防误修改。console感知该状态为consoleProtection时，不允许用户直接修改资源其他配置属性。

约束限制：不影响通过API修改资源属性。类似资源标记，用于提升控制台等用户易用性场景，如防误修改。

取值范围：

  • nonProtection: 不保护。

  • consoleProtection: 控制台修改保护。

默认取值：nonProtection。

protection_reason

否

String

参数解释：设置保护的原因。作为protection_status的转态设置的原因。

约束限制：仅当protection_status为consoleProtection时有效。

取值范围：通用Unicode字符集字符，最大255个字符。

charge_mode

否

String

参数解释：负载均衡器实例的计费模式。

约束限制：不建议用户传该字段。系统会基于用户传入的l4_flavor_id/l7_flavor_id的规格类型，自动识别计费模式。

取值范围：

  • flavor：固定规格计费。

  • lcu：弹性规格计费（按用户实际使用的lcu个数计费）。

默认取值：

  • 若是创建共享型实例，不传默认创建固定规格计费实例。

  • 若是创建独享型实例，则系统会忽略改字段，而是基于用户传入的l4_flavor_id/l7_flavor_id的规格类型，自动识别计费模式。

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

默认取值：5_bgp。

billing_info

否

String

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

约束限制：

  • 空：按需计费。

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 PrepaidCreateOption

参数

是否必选

参数类型

描述

period_type

是

String

参数解释：预付费实例的订购周期类型，当前支持月和年。

取值范围：

  • month：月。

  • year：年。

period_num

否

Integer

参数解释：预付费实例的订购周期数。

取值范围：

  • period_type为month时，为[1,9]。

  • period_type为year时，为[1,3]。

auto_renew

否

Boolean

参数解释：自动续订开关。

取值范围：

  • true：开启自动续订。

  • false：关闭自动续订。

auto_pay

否

Boolean

参数解释：自动支付开关。下单订购后，是否自动从客户的账户中支付。

约束限制：开启自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择关闭自动支付，然后在用户费用中心，选择代金券支付。

取值范围：

  • true：开启自动支付。

  • false：关闭自动支付。
表10 CreateLoadbalancerAutoscalingOption

参数

是否必选

参数类型

描述

enable

是

Boolean

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

取值范围：

  • true：开启。

  • false：关闭。

min_l7_flavor_id

否

String

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

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

响应参数

状态码： 201

表11 响应Body参数

参数

参数类型

描述

loadbalancer

LoadBalancer object

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

loadbalancer_id

String

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

order_id

String

参数解释：订单号

request_id

String

参数解释：请求ID。

注：自动生成 。
表12 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

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

取值范围：

  • 空：按需计费。

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

charge_mode

String

参数解释：负载均衡器实例的计费模式。

取值范围：

  • flavor：按规格计费

  • lcu：按使用量计费

  • 空值：若是共享型表示免费实例。若是独享型则与flavor模式一致，都是按规格计费。

waf_failure_action

String

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

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

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

默认取值：forward

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

protection_status

String

参数解释：修改保护状态。

取值范围：

  • nonProtection: 不保护。

  • consoleProtection: 控制台修改保护。

默认取值：nonProtection

protection_reason

String

参数解释：设置保护的原因

约束限制：仅当protection_status为consoleProtection时有效。

log_group_id

String

参数解释：LB所绑定的logtank对应的group id

log_topic_id

String

参数解释：LB所绑定的logtank对应的topic id
表13 PoolRef

参数

参数类型

描述

id

String

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

参数

参数类型

描述

id

String

参数解释：监听器ID。
表15 Tag

参数

参数类型

描述

key

String

参数解释：标签键

value

String

参数解释：标签值
表16 EipInfo

参数

参数类型

描述

eip_id

String

参数解释：弹性IP的ID。

eip_address

String

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

ip_version

Integer

参数解释：IP版本号。

取值范围：

  • 4表示IPv4。

  • 6表示IPv6。
表17 PublicIpInfo

参数

参数类型

描述

publicip_id

String

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

publicip_address

String

参数解释：IP地址

ip_version

Integer

参数解释：IP版本信息。

取值范围：4和6 4：IPv4 6：IPv6
表18 GlobalEipInfo

参数

参数类型

描述

global_eip_id

String

参数解释：global eip的id

global_eip_address

String

参数解释：global eip的ip地址

ip_version

Integer

参数解释：IP版本信息。

取值范围：

  • 4，表示IPv4

  • 6，表示IPv6
表19 BandwidthRef

参数

参数类型

描述

id

String

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

参数

参数类型

描述

enable

Boolean

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

取值范围：

  • true：开启。

  • false：不开启。

默认取值：false

min_l7_flavor_id

String

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

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

说明：

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

请求示例

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

    POST https://{ELB_Endponit}/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_Endponit}/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"
}

SDK代码示例

SDK代码示例如下。

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

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateLoadBalancerSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateLoadBalancerRequest request = new CreateLoadBalancerRequest();
        CreateLoadBalancerRequestBody body = new CreateLoadBalancerRequestBody();
        List<String> listLoadbalancerAvailabilityZoneList = new ArrayList<>();
        listLoadbalancerAvailabilityZoneList.add("AZ1");
        CreateLoadBalancerOption loadbalancerbody = new CreateLoadBalancerOption();
        loadbalancerbody.withName("loadbalancer")
            .withDescription("simple lb")
            .withVipSubnetCidrId("1992ec06-f364-4ae3-b936-6a8cc24633b7")
            .withAvailabilityZoneList(listLoadbalancerAvailabilityZoneList)
            .withAdminStateUp(true);
        body.withLoadbalancer(loadbalancerbody);
        request.withBody(body);
        try {
            CreateLoadBalancerResponse response = client.createLoadBalancer(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • 示例2 : 创建公网IPv4负载均衡器

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateLoadBalancerSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateLoadBalancerRequest request = new CreateLoadBalancerRequest();
        CreateLoadBalancerRequestBody body = new CreateLoadBalancerRequestBody();
        CreateLoadBalancerBandwidthOption bandwidthPublicip = new CreateLoadBalancerBandwidthOption();
        bandwidthPublicip.withName("bandwidth_test")
            .withSize(2)
            .withChargeMode(CreateLoadBalancerBandwidthOption.ChargeModeEnum.fromValue("bandwidth"))
            .withShareType(CreateLoadBalancerBandwidthOption.ShareTypeEnum.fromValue("PER"));
        CreateLoadBalancerPublicIpOption publicipLoadbalancer = new CreateLoadBalancerPublicIpOption();
        publicipLoadbalancer.withNetworkType("5_bgp")
            .withBandwidth(bandwidthPublicip);
        List<String> listLoadbalancerAvailabilityZoneList = new ArrayList<>();
        listLoadbalancerAvailabilityZoneList.add("AZ1");
        CreateLoadBalancerOption loadbalancerbody = new CreateLoadBalancerOption();
        loadbalancerbody.withName("elb_eip-test")
            .withVipSubnetCidrId("e6e9271d-aef4-48f0-a93a-ccc7b09032c1")
            .withAvailabilityZoneList(listLoadbalancerAvailabilityZoneList)
            .withAdminStateUp(true)
            .withPublicip(publicipLoadbalancer);
        body.withLoadbalancer(loadbalancerbody);
        request.withBody(body);
        try {
            CreateLoadBalancerResponse response = client.createLoadBalancer(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateLoadBalancerRequest()
        listAvailabilityZoneListLoadbalancer = [
            "AZ1"
        ]
        loadbalancerbody = CreateLoadBalancerOption(
            name="loadbalancer",
            description="simple lb",
            vip_subnet_cidr_id="1992ec06-f364-4ae3-b936-6a8cc24633b7",
            availability_zone_list=listAvailabilityZoneListLoadbalancer,
            admin_state_up=True
        )
        request.body = CreateLoadBalancerRequestBody(
            loadbalancer=loadbalancerbody
        )
        response = client.create_load_balancer(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 示例2 : 创建公网IPv4负载均衡器

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateLoadBalancerRequest()
        bandwidthPublicip = CreateLoadBalancerBandwidthOption(
            name="bandwidth_test",
            size=2,
            charge_mode="bandwidth",
            share_type="PER"
        )
        publicipLoadbalancer = CreateLoadBalancerPublicIpOption(
            network_type="5_bgp",
            bandwidth=bandwidthPublicip
        )
        listAvailabilityZoneListLoadbalancer = [
            "AZ1"
        ]
        loadbalancerbody = CreateLoadBalancerOption(
            name="elb_eip-test",
            vip_subnet_cidr_id="e6e9271d-aef4-48f0-a93a-ccc7b09032c1",
            availability_zone_list=listAvailabilityZoneListLoadbalancer,
            admin_state_up=True,
            publicip=publicipLoadbalancer
        )
        request.body = CreateLoadBalancerRequestBody(
            loadbalancer=loadbalancerbody
        )
        response = client.create_load_balancer(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateLoadBalancerRequest{}
	var listAvailabilityZoneListLoadbalancer = []string{
        "AZ1",
    }
	nameLoadbalancer:= "loadbalancer"
	descriptionLoadbalancer:= "simple lb"
	vipSubnetCidrIdLoadbalancer:= "1992ec06-f364-4ae3-b936-6a8cc24633b7"
	adminStateUpLoadbalancer:= true
	loadbalancerbody := &model.CreateLoadBalancerOption{
		Name: &nameLoadbalancer,
		Description: &descriptionLoadbalancer,
		VipSubnetCidrId: &vipSubnetCidrIdLoadbalancer,
		AvailabilityZoneList: listAvailabilityZoneListLoadbalancer,
		AdminStateUp: &adminStateUpLoadbalancer,
	}
	request.Body = &model.CreateLoadBalancerRequestBody{
		Loadbalancer: loadbalancerbody,
	}
	response, err := client.CreateLoadBalancer(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • 示例2 : 创建公网IPv4负载均衡器

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateLoadBalancerRequest{}
	nameBandwidth:= "bandwidth_test"
	sizeBandwidth:= int32(2)
	chargeModeBandwidth:= model.GetCreateLoadBalancerBandwidthOptionChargeModeEnum().BANDWIDTH
	shareTypeBandwidth:= model.GetCreateLoadBalancerBandwidthOptionShareTypeEnum().PER
	bandwidthPublicip := &model.CreateLoadBalancerBandwidthOption{
		Name: &nameBandwidth,
		Size: &sizeBandwidth,
		ChargeMode: &chargeModeBandwidth,
		ShareType: &shareTypeBandwidth,
	}
	publicipLoadbalancer := &model.CreateLoadBalancerPublicIpOption{
		NetworkType: "5_bgp",
		Bandwidth: bandwidthPublicip,
	}
	var listAvailabilityZoneListLoadbalancer = []string{
        "AZ1",
    }
	nameLoadbalancer:= "elb_eip-test"
	vipSubnetCidrIdLoadbalancer:= "e6e9271d-aef4-48f0-a93a-ccc7b09032c1"
	adminStateUpLoadbalancer:= true
	loadbalancerbody := &model.CreateLoadBalancerOption{
		Name: &nameLoadbalancer,
		VipSubnetCidrId: &vipSubnetCidrIdLoadbalancer,
		AvailabilityZoneList: listAvailabilityZoneListLoadbalancer,
		AdminStateUp: &adminStateUpLoadbalancer,
		Publicip: publicipLoadbalancer,
	}
	request.Body = &model.CreateLoadBalancerRequestBody{
		Loadbalancer: loadbalancerbody,
	}
	response, err := client.CreateLoadBalancer(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

POST操作正常返回。

错误码

请参见错误码。

父主题： 负载均衡器