更新时间:2024-04-19 GMT+08:00

创建负载均衡器

功能介绍

创建负载均衡器。

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

  7. l4_flavor_id需要传入网络型规格id,l7_flavor_id需要传入应用型规格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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

负载均衡器的项目ID。

最小长度:0

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM鉴权Token。

最小长度:0

最大长度:4096

表3 请求Body参数

参数

是否必选

参数类型

描述

loadbalancer

CreateLoadBalancerOption object

负载均衡器对象。

表4 CreateLoadBalancerOption

参数

是否必选

参数类型

描述

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。

所有LB实例共享带宽,该字段无效,请勿使用。

最小长度:1

最大长度:36

l7_flavor_id

String

应用型规格ID。

所有LB实例共享带宽,该字段无效,请勿使用。

最小长度: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地址。

表5 Tag

参数

是否必选

参数类型

描述

key

String

标签键

最小长度:1

最大长度:36

value

String

标签值

最小长度:0

最大长度:43

表6 BandwidthRef

参数

是否必选

参数类型

描述

id

String

共享带宽的id

表7 CreateLoadBalancerPublicIpOption

参数

是否必选

参数类型

描述

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

CreateLoadBalancerBandwidthOption object

bandwidth

表8 CreateLoadBalancerBandwidthOption

参数

是否必选

参数类型

描述

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

资源账单信息。

不支持该字段,请勿使用

最小长度:1

最大长度:1024

id

String

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

最小长度:1

最大长度:36

表9 CreateLoadbalancerAutoscalingOption

参数

是否必选

参数类型

描述

enable

Boolean

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

缺省值:false

min_l7_flavor_id

String

弹性扩缩容的最小七层规格ID,类型为L7_elastic,有七层监听器时,该字段不能为空。

该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。

最小长度:1

最大长度:36

响应参数

状态码: 201

表10 响应Body参数

参数

参数类型

描述

loadbalancer

LoadBalancer object

负载均衡器对象。

loadbalancer_id

String

负载均衡器的ID(包周期场景返回该字段)

不支持该字段,请勿使用

最小长度:0

最大长度:36

order_id

String

订单号(包周期场景返回该字段)

不支持该字段,请勿使用

最小长度:0

最大长度:36

request_id

String

请求ID。

注:自动生成 。

最小长度:0

最大长度:36

表11 LoadBalancer

参数

参数类型

描述

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

资源账单信息。

取值:

  • 空:按需计费。

  • 非空:包周期计费,

包周期计费billing_info字段的格式为:order_id:product_id:region_id:project_id,如:

CS2107161019CDJZZ:OFFI569702121789763584: az:057ef081eb00d2732fd1c01a9be75e6f

不支持该字段,请勿使用

最小长度:1

最大长度:1024

l4_flavor_id

String

网络型规格ID。

对于弹性扩缩容实例,表示上限规格。

当传入的规格类型为L4,表示该实例为固定规格实例,按规格计费; 当传入的规格类型为L4_elastic_max,表示该实例为弹性实例,按LCU计费

hsco场景下所有LB实例共享带宽,该字段无效,请勿使用。

最小长度:1

最大长度:255

l4_scale_flavor_id

String

四层弹性Flavor ID。

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

最小长度:1

最大长度:255

l7_flavor_id

String

应用型ID。 对于弹性扩缩容实例,表示上限规格ID。

当传入的规格类型为L7,表示该实例为固定规格实例,按规格计费; 当传入的规格类型为L7_elastic_max,表示该实例为弹性实例,按LCU计费

hsco场景下所有LB实例共享带宽,该字段无效,请勿使用。

最小长度: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

负载均衡器的冻结场景。

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

表12 PoolRef

参数

参数类型

描述

id

String

后端服务器组ID。

表13 ListenerRef

参数

参数类型

描述

id

String

监听器ID。

表14 Tag

参数

参数类型

描述

key

String

标签键

最小长度:1

最大长度:36

value

String

标签值

最小长度:0

最大长度:43

表15 EipInfo

参数

参数类型

描述

eip_id

String

eip_id

eip_address

String

eip_address

ip_version

Integer

IP版本号。

取值:4表示IPv4,6表示IPv6。

表16 PublicIpInfo

参数

参数类型

描述

publicip_id

String

弹性公网ip配置id

publicip_address

String

IP地址

ip_version

Integer

IP版本信息。 取值范围:4和6 4:IPv4 6:IPv6

表17 GlobalEipInfo

参数

参数类型

描述

global_eip_id

String

global eip的id

global_eip_address

String

global eip的ip地址

ip_version

Integer

IP版本信息。 取值范围:4和6 4:IPv4 6:IPv6

表18 BandwidthRef

参数

参数类型

描述

id

String

共享带宽的id

表19 AutoscalingRef

参数

参数类型

描述

enable

Boolean

当前负载均衡器是否开启弹性扩缩容。

取值:

  • true:开启。

  • false:不开启,默认值。

min_l7_flavor_id

String

弹性扩缩容的最小七层规格ID(规格类型L7_elastic),有七层监听器时,该字段不能为空。

该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。

最小长度:1

最大长度:36

请求示例

  • 示例1 : 创建一个私网IPv4负载均衡器

    POST https://{ELB_Endponit}/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_Endponit}/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操作正常返回。

错误码

请参见错误码