创建负载均衡器

project_id

是

String

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

X-Auth-Token

否

String

参数解释：IAM鉴权Token。

loadbalancer

是

CreateLoadBalancerOption object

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

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 接口来查询可用区集合列表。创建负载均衡器时，从查询结果选择某一个可用区集合，并从中选择一个或多个可用区。

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中的后端子网必须支持双栈。

key

否

String

参数解释：标签键

value

否

String

参数解释：标签值

id

是

String

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

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

参数解释：带宽信息

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。在预付费的情况下，不填该字段。该字段取空字符串时，会被忽略。

enable

是

Boolean

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

取值范围：

• true：开启。

• false：关闭。

min_l7_flavor_id

否

String

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

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

loadbalancer

LoadBalancer object

参数解释：负载均衡器对象。（包周期场景不返回该字段）

request_id

String

参数解释：请求ID。

注：自动生成 。

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

id

String

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

id

String

参数解释：监听器ID。

key

String

参数解释：标签键

value

String

参数解释：标签值

eip_id

String

参数解释：弹性IP的ID。

eip_address

String

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

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，表示IPv4

• 6，表示IPv6

id

String

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

enable

Boolean

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

取值范围：

• true：开启。

• false：不开启。

默认取值：false

min_l7_flavor_id

String

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

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

201

POST操作正常返回。