创建负载均衡器
功能介绍
创建负载均衡器。
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.不支持绑定已有未使用的内网IPv4、内网IPv6或公网IPv6地址。
接口约束
1.vpc_id 或 vip_subnet_cidr_id 或 ipv6_vip_virsubnet_id 不能同时为空。
2.ip_target_enable参数表示是否启用跨VPC后端转发能力,开启后可以配置将请求转发到不同的VPC,未开启则只能将请求转发到当前LB所在VPC的后端服务器上。
3.admin_state_up参数的值必须是true。
4.provider参数的值必须是vlb。
5.elb_virsubnet_ids参数对应的网络类型支持双栈或者只支持ipv4。网络类型为只支持ipv4时,ipv6_vip_virsubnet_id参数需要为空。
6.只能通过ELB Console控制台来解绑EIP,在ELB列表查询页面选择操作列中的更多按钮->解绑EIP。
7.创建LB时不能同时设置publicip_ids和publicip,只能选择绑定已有公网IP或者选择新建公网IP,或者都不设置这两个字段。
8.若要绑定已有带宽,则需要设置共享带宽ID,不支持绑定独享带宽。若需要新建独享带宽,则带宽信息中charge_mode、share_type和size字段是必须的。
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/elb/loadbalancers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
负载均衡器的项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM鉴权Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
loadbalancer |
是 |
CreateLoadBalancerOption object |
负载均衡器对象。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
负载均衡器的名称。 最小长度:0 最大长度:255 |
description |
否 |
String |
负载均衡器的描述。 最小长度:0 最大长度:255 |
vip_address |
否 |
String |
负载均衡器的IPv4虚拟IP。该地址必须包含在所在子网的IPv4网段内,且未被占用。 使用说明:
|
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下。
最小长度:1 最大长度:36 |
ipv6_vip_virsubnet_id |
否 |
String |
双栈类型负载均衡器所在子网的IPv6网络ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的id得到。 使用说明:
|
provider |
否 |
String |
负载均衡器的生产者名称。固定为vlb。 最小长度:1 最大长度:255 正则匹配:(?i)vlb |
l4_flavor_id |
否 |
String |
四层Flavor ID。 hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。 注意:当l4_flavor_id和l7_flavor_id都不传的时,会使用默认flavor。 最小长度:1 最大长度:36 |
project_id |
否 |
String |
负载均衡器所在的项目ID。 最小长度:1 最大长度:32 正则匹配:[0-9a-fA-F]{32} |
guaranteed |
否 |
Boolean |
是否独享型负载均衡器。取值:
当前只支持设置为true,设置为false会返回400 Bad Request 。默认:true。 |
vpc_id |
否 |
String |
负载均衡器所在的VPC ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/vpcs 响应参数中的id得到。 使用说明:
|
availability_zone_list |
是 |
Array of strings |
可用区列表。可通过GET https://{ELB_Endpoint}/v3/{project_id}/elb/availability-zones接口来查询可用区集合列表。创建负载均衡器时,从查询结果选择某一个可用区集合,并从中选择一个或多个可用区。 |
enterprise_project_id |
否 |
String |
负载均衡器所属的企业项目ID。 |
tags |
否 |
Array of Tag objects |
负载均衡的标签列表。示例:"tags":[{"key":"my_tag","value":"my_tag_value"}] |
admin_state_up |
否 |
Boolean |
负载均衡器的管理状态。只能设置为true。默认:true。 |
l7_flavor_id |
否 |
String |
七层Flavor ID。 hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。 注意:当l4_flavor_id和l7_flavor_id都不传的时,会使用默认flavor。 最小长度:1 最大长度:36 |
billing_info |
否 |
String |
资源账单信息。 取值:
最小长度:1 最大长度:1024 |
ipv6_bandwidth |
否 |
BandwidthRef object |
带宽对象ID,仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时,此EIP会被分进共享带宽里面。 |
publicip_ids |
否 |
Array of strings |
负载均衡器绑定的公网IP ID。只支持绑定数组中的第一个EIP,其他将被忽略。 |
publicip |
否 |
创建ELB时,新建公网IP请求参数 |
|
elb_virsubnet_ids |
否 |
Array of strings |
下联面子网的网络ID列表。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的id得到。 使用说明:
|
ip_target_enable |
否 |
Boolean |
是否启用跨VPC后端转发。开启跨VPC后端转发后,后端服务器组支持添加其他VPC、其他公有云、云下数据中心的服务器。取值: - true:开启。 - false:不开启。 仅独享型负载均衡器支持该特性。 |
deletion_protection_enable |
否 |
Boolean |
是否开启删除保护。取值:false不开启,true开启。默认false不开启。 说明:
退场时需要先关闭所有资源的删除保护开关。 |
prepaid_options |
否 |
PrepaidCreateOption object |
创建负载均衡器的包周期信息,若传入该结构体,则创建包周期的LB |
autoscaling |
否 |
弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。 使用说明:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ip_version |
否 |
Integer |
IP版本。取值:4表示IPv4,6表示IPv6。 缺省值:4 |
network_type |
是 |
String |
弹性公网IP的网络类型,默认5_bgp,更多请参考弹性公网ip创建。 最小长度:1 最大长度:36 |
billing_info |
否 |
String |
资源账单信息,取值:
最小长度:1 最大长度:1024 |
description |
否 |
String |
弹性公网IP的描述信息,不支持特殊字符 最小长度:1 最大长度:255 |
bandwidth |
是 |
bandwidth |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
带宽名称。取值:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点) 使用说明:
最小长度:1 最大长度:64 正则匹配:[\u4e00-\u9fa5A-Za-z0-9_.-]+ |
size |
否 |
Integer |
带宽大小 取值范围:默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。 注意:调整带宽时的最小单位会根据带宽范围不同存在差异。 小于等于300Mbit/s:默认最小单位为1Mbit/s。 300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。 大于1000Mbit/s:默认最小单位为500Mbit/s。 使用说明:
最小值:0 最大值:99999 |
charge_mode |
否 |
String |
计费模式。 取值范围:bandwidth表示按带宽计费,traffic表示按流量计费。 使用说明: - 当id字段为null时,charge_mode是必须的。 最小长度:1 最大长度:36 |
share_type |
否 |
String |
带宽类型。 取值:
使用说明:
|
billing_info |
否 |
String |
预留资源账单信息,默认为空表示按需计费,非空为包周期。 不支持该字段,请勿使用。 最小长度:1 最大长度:1024 |
id |
否 |
String |
功能说明:使用已有的共享带宽创建IP 取值范围:共享带宽ID 使用说明:
最小长度:1 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
period_type |
是 |
String |
订购周期类型,仅在change_mode为delay时有效。取值:
|
period_num |
否 |
Integer |
订购周期数,仅在change_mode为delay时有效。取值:
最小值:1 最大值:9 缺省值:1 |
auto_renew |
否 |
Boolean |
是否自动续订; true:自动续订 false:不自动续订 缺省值:false |
auto_pay |
否 |
Boolean |
下单订购后,是否自动从客户的账户中支付; true:自动支付; false:不自动支付。 自动支付时,只能使用账户的现金支付;如果要使用代金券,请选择不自动支付,然后在用户费用中心,选择代金券支付。 缺省值:false |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
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 |
负载均衡器的配置状态。取值:
|
admin_state_up |
Boolean |
负载均衡器的管理状态。固定为true。 |
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 |
billing_info |
String |
资源账单信息。 取值:
包周期计费billing_info字段的格式为:order_id:product_id:region_id:project_id,如: CS2107161019CDJZZ:OFFI569702121789763584:eu-de:057ef081eb00d2732fd1c01a9be75e6f 使用说明:
最小长度:1 最大长度:1024 |
l4_flavor_id |
String |
四层Flavor ID。 hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。 最小长度:1 最大长度:255 |
l4_scale_flavor_id |
String |
四层弹性Flavor ID。 不支持该字段,请勿使用。 最小长度:1 最大长度:255 |
l7_flavor_id |
String |
七层Flavor ID。 hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。 最小长度:1 最大长度:255 |
l7_scale_flavor_id |
String |
七层弹性Flavor ID。 不支持该字段,请勿使用。 最小长度:1 最大长度:255 |
publicips |
Array of PublicIpInfo objects |
负载均衡器绑定的公网IP。只支持绑定一个公网IP。 注:该字段与eips一致。 |
elb_virsubnet_ids |
Array of strings |
下联面子网的网络ID列表。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的id得到。 使用说明:
|
elb_virsubnet_type |
String |
下联面子网类型
|
ip_target_enable |
Boolean |
是否启用跨VPC后端转发。开启跨VPC后端转发后,后端服务器组支持添加其他VPC、其他公有云、云下数据中心的服务器。取值: - true:开启。 - false:不开启。 仅独享型负载均衡器支持该特性。 |
frozen_scene |
String |
负载均衡器的冻结场景。若负载均衡器有多个冻结场景,用逗号分隔。取值:
|
ipv6_bandwidth |
BandwidthRef object |
带宽对象ID,仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时,此EIP会被分进共享带宽里面。 |
deletion_protection_enable |
Boolean |
是否开启删除保护,取值:
仅当前局点启用删除保护特性后才会返回该字段。 说明:
退场时需要先关闭所有资源的删除保护开关。 |
autoscaling |
AutoscalingRef object |
弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。 使用说明:
|
参数 |
参数类型 |
描述 |
---|---|---|
eip_id |
String |
eip_id |
eip_address |
String |
eip_address |
ip_version |
Integer |
IP版本号,取值:4表示IPv4,6表示IPv6。 |
请求示例
示例1 : 创建内网IPv4负载均衡器
POST https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/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操作正常返回。
{ "request_id" : "6c63d0ac-7beb-451d-a3e0-a066beaea316", "loadbalancer" : { "loadbalancer" : { "id" : "cce5318e-c79a-4f68-94a2-9fb285c6efbe", "project_id" : "060576782980d5762f9ec014dd2f1148", "name" : "elb-reset", "description" : "", "vip_port_id" : null, "vip_address" : null, "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ ], "pools" : [ ], "tags" : [ ], "provider" : "vlb", "created_at" : "2021-07-26T02:46:31Z", "updated_at" : "2021-07-26T02:46:59Z", "vpc_id" : "59cb11ef-f185-49ba-92af-0539e8ff9734", "enterprise_project_id" : "0", "availability_zone_list" : [ "eu-de-01" ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "publicips" : [ { "publicip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "publicip_address" : "97.97.2.171", "ip_version" : 4 } ], "elb_virsubnet_ids" : [ "7f817f9c-8731-4002-9e47-18cb8d431787" ], "elb_virsubnet_type" : "dualstack", "ip_target_enable" : false, "autoscaling" : { "enable" : false, "min_l4_flavor_id" : "", "min_l7_flavor_id" : "" }, "frozen_scene" : null, "eips" : [ { "eip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "eip_address" : "97.97.2.171", "ip_version" : 4 } ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "636ba721-935a-4ca5-a685-8076ce0e4148", "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : null } } }
状态码
状态码 |
描述 |
---|---|
201 |
POST操作正常返回。 |
错误码
请参见错误码。
