创建负载均衡器

project_id

是

String

负载均衡器的项目ID。

最小长度：0

最大长度：36

X-Auth-Token

否

String

IAM鉴权Token。

最小长度：0

最大长度：4096

loadbalancer

是

CreateLoadBalancerOption object

负载均衡器对象。

id

否

String

负载均衡器ID（UUID）。不支持该字段，请勿使用。

最小长度：0

最大长度：36

project_id

否

String

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

最小长度：1

最大长度：32

name

否

String

负载均衡器的名称。

最小长度：0

最大长度：255

description

否

String

负载均衡器的描述。

最小长度：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，则不分配虚拟IP，vip_address=null。

vip_subnet_cidr_id

否

String

负载均衡器所在子网的IPv4子网ID。若需要创建带IPv4虚拟IP的LB，该字段必须传入。 可以通过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。

最小长度：1

最大长度：36

ipv6_vip_virsubnet_id

否

String

双栈类型负载均衡器所在子网的IPv6网络ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。

使用说明：

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

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

provider

否

String

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

最小长度：1

最大长度：255

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计费。

最小长度：1

最大长度：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计费。

最小长度：1

最大长度：36

guaranteed

否

Boolean

是否独享型负载均衡器。

取值：

• true：独享型。

• false：共享型。

当前只支持设置为true，设置为false会返回400 Bad Request 。默认：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下。

availability_zone_list

是

Array of strings

可用区列表。可通过GET

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

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。默认：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列表。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。

若不指定该字段，则按如下规则选择下联面网络：

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

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

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

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

下联面子网必须属于该LB所在的VPC。

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

key

否

String

标签键

最小长度：1

最大长度：36

value

否

String

标签值

最小长度：0

最大长度：43

id

是

String

共享带宽的id

ip_version

否

Integer

IP版本。

取值：4表示IPv4，6表示IPv6。

缺省值：4

network_type

是

String

弹性公网IP的网络类型，默认5_bgp，更多请参考弹性公网ip创建。

华南-深圳局点该参数取值只能为5_gray

最小长度：1

最大长度：36

billing_info

否

String

资源账单信息。

取值：

• 空：按需计费。

• 非空：包周期计费。

最小长度：1

最大长度：1024

description

否

String

弹性公网IP的描述信息，不支持特殊字符

最小长度：1

最大长度：255

bandwidth

是

CreateLoadBalancerBandwidthOption object

bandwidth

name

否

String

带宽名称。

取值：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

使用说明：

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

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

最小长度：1

最大长度：64

size

否

Integer

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

注意:调整带宽时的最小单位会根据带宽范围不同存在差异。 小于等于300Mbit/s:默认最小单位为1Mbit/s。 300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。 大于1000Mbit/s:默认最小单位为500Mbit/s。

使用说明：当id字段为null时，size是必须的。

最小值：0

最大值：99999

charge_mode

否

String

计费模式。

取值：bandwidth表示按带宽计费，traffic表示按流量计费。

使用说明：当id字段为null时，charge_mode是必须的。

最小长度：1

最大长度：36

share_type

否

String

带宽类型。

取值：

• PER：独享带宽。

• WHOLE：共享带宽。

使用说明：

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

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

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

billing_info

否

String

资源账单信息。

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

最小长度：1

最大长度：1024

id

否

String

功能说明：使用已有的共享带宽创建IP 取值范围：共享带宽ID 使用说明： WHOLE类型的带宽ID； 在预付费的情况下，不填该值。该字段取空字符串时，会被忽略。

最小长度：1

最大长度：36

period_type

是

String

订购周期类型，当前支持包月和包年： month：月； year：年；

period_num

否

Integer

订购周期数，取值会随运营策略变化。 period_type为month时，为[1,9]， period_type为year时，为[1,3]

最小值：1

最大值：9

缺省值：1

auto_renew

否

Boolean

是否自动续订； true：自动续订 false：不自动续订

缺省值：false

auto_pay

否

Boolean

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

缺省值：false

enable

是

Boolean

负载均衡器弹性扩缩容开关

缺省值：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

201

POST操作正常返回。