创建负载均衡器

project_id

是

String

参数解释：项目ID。获取方式请参见获取项目ID。

约束限制：不涉及

取值范围：长度为32个字符，由小写字母和数字组成。

默认取值：不涉及

X-Auth-Token

否

String

参数解释：IAM鉴权Token。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

loadbalancer

是

CreateLoadBalancerOption object

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

约束限制：不涉及

project_id

否

String

参数解释：项目ID。获取方式请参见获取项目ID。

约束限制：不涉及

取值范围：长度为32个字符，由小写字母和数字组成。

默认取值：不涉及

name

否

String

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

约束限制：不涉及

取值范围：支持中文字符、英文字符等unicode字符，且长度为[0-255]个字符。可以为空。

默认取值：不涉及

description

否

String

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

约束限制：不涉及

取值范围：支持中文字符、英文字符等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。

• 网关型LB不支持传入vip_address。

取值范围：满足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。

• 创建网关型LB，vip_subnet_cidr_id和ipv6_vip_virsubnet_id不能同时为空。若都传入则必须是同一个子网的IPv4子网ID和IPv6网络ID。

取值范围：标准的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。

• 创建网关型LB，vip_subnet_cidr_id和ipv6_vip_virsubnet_id不能同时为空。若都传入则必须是同一个子网的IPv4子网ID和IPv6网络ID。

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

默认取值：不涉及

provider

否

String

参数解释：负载均衡器的生产者名称。

约束限制：不涉及

取值范围：固定为vlb，无需指定。

默认取值：vlb

l4_flavor_id

否

String

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

约束限制：

网关型LB不支持指定l4_flavor_id。

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

默认取值：不涉及

l7_flavor_id

否

String

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

约束限制：

• 网关型LB不支持指定l7_flavor_id。

取值范围：标准的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。创建时不传则资源属于default企业项目，返回enterprise_project_id="0"。

约束限制：不能传入空字符串""、"0"或不存在的企业项目ID。

取值范围：不涉及

默认取值："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。

约束限制：

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

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

publicip_ids

否

Array of strings

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

约束限制：

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

• 网关型LB不支持该字段。

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

参数解释：是否启用IP类型后端转发。

约束限制：

• 开启后不能关闭。

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

• 网关型LB不支持该特性。

取值范围：

• true：开启。

• false：不开启。

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

• 网关型LB不支持指定ipv6_vip_address。

取值范围：不涉及

默认取值：不涉及

key

否

String

参数解释：标签键。

取值范围：不涉及

value

否

String

参数解释：标签值。

取值范围：不涉及

id

是

String

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

ip_version

否

Integer

参数解释：IP版本。

约束限制：不涉及

取值范围：

• 4：表示IPv4。

• 6：表示IPv6。

默认取值：4

network_type

是

String

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

取值范围：5_bgp - 全动态BGP。

默认取值：5_bgp

billing_info

否

String

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

约束限制：

• 空：按需计费。

取值范围：不涉及

默认取值：不涉及

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

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

参数解释：计费模式。

约束限制：当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

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

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

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

id

否

String

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

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

取值范围：不涉及

默认取值：不涉及

enable

是

Boolean

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

约束限制：网关型LB不支持该字段。

取值范围：

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

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企业项目。

• UUID格式的字符串，表示非默认企业项目。

billing_info

String

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

取值范围：

• 空：按需计费。

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

l4_flavor_id

String

参数解释：负载均衡器4层规格ID。

若当前负载均衡器是弹性规格实例，则该字段表示4层上限规格。

取值范围：不涉及

l4_scale_flavor_id

String

参数解释：四层弹性规格ID。

取值范围：不涉及

l7_flavor_id

String

参数解释：负载均衡器7层规格ID。

若当前负载均衡器是弹性规格实例，则该字段表示7层上限规格。

取值范围：不涉及

l7_scale_flavor_id

String

参数解释：七层弹性Flavor ID。

取值范围：不涉及

gw_flavor_id

String

参数解释：网关型负载均衡器的规格ID。

取值范围：不涉及

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

loadbalancer_type

String

参数解释：负载均衡器类别。

取值范围：

• gateway 表示网关类型负载均衡器。

• null 表示其他非网关类型负载均衡器。

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

publicips

Array of PublicIpInfo objects

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

global_eips

Array of GlobalEipInfo objects

参数解释：负载均衡器绑定的global eip。

elb_virsubnet_ids

Array of strings

参数解释：下联面子网的网络ID列表。

取值范围：不涉及

elb_virsubnet_type

String

参数解释：下联面子网类型。

取值范围：

• ipv4：仅支持IPv4

• dualstack：双栈，同时支持IPv4和IPv6。

ip_target_enable

Boolean

参数解释：是否启用IP类型后端转发。

取值范围：

• true：开启。

• false：不开启。

frozen_scene

String

参数解释：负载均衡器的冻结场景。

若负载均衡器有多个冻结场景，用逗号分隔。

取值范围：

• ILLEGAL：违规冻结场景。

• VERIFY：客户未实名认证冻结场景。

• PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。

• ARREAR：欠费冻结场景。

deletion_protection_enable

Boolean

参数解释：是否开启删除保护。仅当前局点启用删除保护特性后才会返回该字段。

取值范围：

• false：不开启。

• true：开启。

autoscaling

AutoscalingRef object

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

public_border_group

String

参数解释：公网边界组。

取值范围：

• center：表示中心站点的公网边界组

• 边缘站点名称：表示边缘站点的公网边界组

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

charge_mode

String

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

取值范围：

• flavor：按规格计费。

• lcu：按使用量计费。

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

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

service_lb_mode

String

参数解释：LB模式。

取值范围：

• lb：默认模式，不支持跨租户访问。

• ep：ep模式，LB支持跨租户访问。

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

instance_type

String

参数解释：标识实例归属哪个内部服务。

取值范围：不涉及

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

instance_id

String

参数解释：标识实例绑定内部服务的实例id。

取值范围：不涉及

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

proxy_protocol_extensions

Array of ProxyProtocolExtension objects

参数解释：pp扩展。

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

waf_failure_action

String

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

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

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

custom_qos_limit

CustomQosLimit object

参数解释：弹性负载均衡器的规格的自定义限速信息。

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

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

参数解释：弹性公网EIP的ID。

取值范围：不涉及

publicip_address

String

参数解释：EIP的IP地址。

取值范围：不涉及

ip_version

Integer

参数解释：IP版本信息。

取值范围：

• 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

enable

Boolean

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

取值范围：

• true：开启。

• false：不开启。

min_l7_flavor_id

String

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

取值范围：不涉及

vip_address

String

参数解释：ipv4 vip地址。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

ipv6_vip_address

String

参数解释：ipv6 vip地址。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

extension

Extension object

参数解释：pp 扩展。

约束限制：不涉及

ep_id

String

参数解释：EP ID.

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

ep_service_id

String

参数解释：EP Service ID.

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

l4

L4Limit object

参数解释：负载均衡实例的四层规格自定义限速信息。

l7

L7Limit object

参数解释：负载均衡实例的七层规格自定义限速信息。

connection

Integer

参数解释：负载均衡实例的四层规格的最大并发连接数限速值。

取值范围：不涉及

cps

Integer

参数解释：负载均衡实例的四层规格的每秒新建连接数限速值。

取值范围：不涉及

connection

Integer

参数解释：负载均衡实例的七层规格的最大并发连接数限速值。

取值范围：不涉及

cps

Integer

参数解释：负载均衡实例的七层规格的每秒新建连接数限速值。

取值范围：不涉及

201

POST操作正常返回。