创建负载均衡器
功能介绍
创建独享型负载均衡器,包括按需及包周期计费负载均衡器。
-
若要创建内网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
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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网段内,且未被占用。 约束限制:
取值范围:满足IPv4的地址格式,[0-255].[0-255].[0-255].[0-255]. 如192.168.1.1。 |
vip_subnet_cidr_id |
否 |
String |
参数解释:负载均衡器所在子网的IPv4子网ID,也称为该负载均衡器实例的前端子网。 约束限制:
取值范围:标准的UUID格式,长度为36个字符。 |
ipv6_vip_virsubnet_id |
否 |
String |
参数解释:双栈类型负载均衡器所在子网的IPv6网络ID,也称为该负载均衡器实例的前端子网。 约束限制:
取值范围:标准的UUID格式,长度为36个字符。 |
provider |
否 |
String |
参数解释:负载均衡器的生产者名称。固定为vlb,无需指定。 |
l4_flavor_id |
否 |
String |
参数解释:网络型规格ID。 约束限制:
取值范围:标准的UUID格式,长度为36个字符。 |
l7_flavor_id |
否 |
String |
参数解释:应用型规格ID。 约束限制:
取值范围:标准的UUID格式,长度为36个字符。 |
guaranteed |
否 |
Boolean |
参数解释:是否为独享型负载均衡器实例。 约束限制:当前只支持设置为true,设置为false会返回400 Bad Request。 取值范围:
默认取值:true。 |
vpc_id |
否 |
String |
参数解释:负载均衡器所在的VPC ID。 约束限制:
取值范围:标准的UUID格式,长度为36个字符。 |
availability_zone_list |
是 |
Array of strings |
参数解释:负载均衡器实例所在的可用区列表。 约束限制:
为了支持可用区容灾,建议选取不少于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。 |
ipv6_bandwidth |
否 |
BandwidthRef object |
参数解释:带宽对象ID。 约束限制:
|
publicip_ids |
否 |
Array of strings |
参数解释:负载均衡器绑定的公网IP的ID的数组。 约束限制:
|
publicip |
否 |
参数解释:创建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字段。 约束限制:
|
ip_target_enable |
否 |
Boolean |
参数解释:是否启用跨VPC后端转发。 开启跨VPC后端转发后,后端服务器组不仅支持添加云上VPC内的服务器,还支持添加其他VPC、其他公有云、云下数据中心的服务器。 约束限制:
取值范围:
|
deletion_protection_enable |
否 |
Boolean |
参数解释:实例删除保护开关。 约束限制:实例删除前,需要先关闭该实例下所有资源的删除保护开关。 取值范围:
默认取值:false。 |
autoscaling |
否 |
参数解释:弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。 约束限制:
该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。 |
|
ipv6_vip_address |
否 |
String |
参数解释:负载均衡器实例的IPv6地址。 约束限制:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ip_version |
否 |
Integer |
参数解释:IP版本。 约束限制:取值只有4和6。4:IPv4, 6: IPv6。 取值范围:
默认取值:4 |
network_type |
是 |
String |
参数解释:弹性公网IP的网络类型,默认5_bgp,更多请参考弹性公网ip创建。 约束限制:华南-深圳局点该参数取值只能为5_gray。 取值范围:5_bgp。 默认取值:5_bgp。 |
billing_info |
否 |
String |
参数解释:计费订单信息。 约束限制:
|
description |
否 |
String |
参数解释:弹性公网IP的描述信息。 |
bandwidth |
是 |
参数解释:带宽信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
参数解释:带宽名称。 约束限制:
取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点) |
size |
否 |
Integer |
参数解释:带宽大小。 约束限制:当id字段为null时,size是必须的。 注意,调整带宽时的最小单位会根据带宽范围不同存在差异。
取值范围:默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。 |
charge_mode |
否 |
String |
参数解释:计费模式。bandwidth 按带宽计费;traffic 按流量计费。 约束限制:当id字段为null时,charge_mode是必须的。 取值范围:
|
share_type |
否 |
String |
参数解释:带宽类型。 约束限制:
取值范围:
|
billing_info |
否 |
String |
参数解释:资源计费信息。 约束限制: 如果billing_info不为空,说明是包周期计费的带宽,否则为按需计费的带宽。 |
id |
否 |
String |
参数解释:共享带宽ID。使用已存在的共享带宽。 约束限制:必须是已存在共享带宽ID。在预付费的情况下,不填该字段。该字段取空字符串时,会被忽略。 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
loadbalancer |
LoadBalancer object |
参数解释:负载均衡器对象。(包周期场景不返回该字段) |
request_id |
String |
参数解释:请求ID。 注:自动生成 。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释:负载均衡器ID。 |
description |
String |
参数解释:负载均衡器描述信息。 |
provisioning_status |
String |
参数解释:负载均衡器的配置状态。 取值范围:
|
admin_state_up |
Boolean |
参数解释:负载均衡器的启用状态。 取值范围:
|
provider |
String |
参数解释:负载均衡器的生产者名称。固定为vlb。 |
pools |
Array of PoolRef objects |
参数解释:负载均衡器直接关联的后端服务器组的ID列表。 |
listeners |
Array of ListenerRef objects |
参数解释:负载均衡器关联的监听器的ID列表。 |
operating_status |
String |
参数解释:负载均衡器的操作状态。 取值范围:
|
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。 取值范围:
|
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_scale_flavor_id |
String |
参数解释:四层弹性Flavor ID。 不支持该字段,请勿使用。 |
l7_flavor_id |
String |
参数解释:应用型ID。 对于弹性扩缩容实例,表示上限规格ID。 约束限制:
|
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 |
参数解释:下联面子网类型。 取值范围:
|
ip_target_enable |
Boolean |
参数解释:是否启用跨VPC后端转发。 开启跨VPC后端转发后,后端服务器组不仅支持添加云上VPC内的服务器,还支持添加其他VPC、其他公有云、云下数据中心的服务器。 约束限制:
取值范围:
|
frozen_scene |
String |
参数解释:负载均衡器的冻结场景。 若负载均衡器有多个冻结场景,用逗号分隔。 取值范围:
|
ipv6_bandwidth |
BandwidthRef object |
参数解释:带宽对象ID。 约束限制:
|
deletion_protection_enable |
Boolean |
参数解释:是否开启删除保护。 约束限制:
取值范围:
|
autoscaling |
AutoscalingRef object |
参数解释:弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。 约束限制:
该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。 |
public_border_group |
String |
参数解释:LB所属AZ组。 |
waf_failure_action |
String |
参数解释:WAF故障时的流量处理策略。 约束限制:只有绑定了waf的LB实例,该字段才会生效。 取值范围:discard:丢弃,forward: 转发到后端。 默认取值:forward |
参数 |
参数类型 |
描述 |
---|---|---|
eip_id |
String |
参数解释:弹性IP的ID。 |
eip_address |
String |
参数解释:弹性IP的IP地址。 |
ip_version |
Integer |
参数解释:IP版本号。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
publicip_id |
String |
参数解释:弹性公网ip配置id |
publicip_address |
String |
参数解释:IP地址 |
ip_version |
Integer |
参数解释:IP版本信息。 取值范围:4和6 4:IPv4 6:IPv6 |
请求示例
-
示例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操作正常返回。 |
错误码
请参见错误码。