更新时间:2022-03-31 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地址。

接口约束

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

负载均衡器的项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM鉴权Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

loadbalancer

CreateLoadBalancerOption object

负载均衡器对象。

表4 CreateLoadBalancerOption

参数

是否必选

参数类型

描述

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 响应参数中的id得到。

使用说明:

  • vpc_id,vip_subnet_cidr_id,ipv6_vip_virsubnet_id不能同时为空,且需要在同一个vpc下。

  • 需要对应的子网开启IPv6。

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:共享型。

当前只支持设置为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_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

资源账单信息。 取值:

  • 空:按需计费。

  • 非空:包周期计费。 包周期计费billing_info字段的格式为:order_id:product_id:region_id:project_id,如: CS2107161019CDJZZ:OFFI569702121789763584:eu-de:057ef081eb00d2732fd1c01a9be75e6f

最小长度:1

最大长度:1024

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 响应参数中的id得到。

使用说明:

  • 若不指定该字段,则会在当前负载均衡器所在子网作为下联面子网。

  • 若指定多个下联面子网,则按顺序优先使用第一个子网来为负载均衡器下联面端口分配ip地址。

  • 下联面子网必须属于该LB所在的VPC。

  • 不支持边缘云子网。

ip_target_enable

Boolean

是否启用跨VPC后端转发。开启跨VPC后端转发后,后端服务器组支持添加其他VPC、其他公有云、云下数据中心的服务器。取值: - true:开启。 - false:不开启。 仅独享型负载均衡器支持该特性。

deletion_protection_enable

Boolean

是否开启删除保护。取值:false不开启,true开启。默认false不开启。

说明:

退场时需要先关闭所有资源的删除保护开关。

prepaid_options

PrepaidCreateOption object

创建负载均衡器的包周期信息,若传入该结构体,则创建包周期的LB

autoscaling

CreateLoadbalancerAutoscalingOption object

弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。

使用说明:

  • 仅当局点支持弹性扩缩特性该字段才有效。可咨询客服了解当前局点是否支持弹性扩缩容特性。

  • 开启弹性扩缩容后,l4_flavor_id和l7_flavor_id不再起作用。

表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

正则匹配:[\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。

使用说明:

  • 当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 PrepaidCreateOption

参数

是否必选

参数类型

描述

period_type

String

订购周期类型,仅在change_mode为delay时有效。取值:

  • month:月(默认)。

  • year:年。

period_num

Integer

订购周期数,仅在change_mode为delay时有效。取值:

  • period_type为month时,为[1,9],默认1。

  • period_type为year时,为[1,3],默认1。

最小值:1

最大值:9

缺省值:1

auto_renew

Boolean

是否自动续订; true:自动续订 false:不自动续订

缺省值:false

auto_pay

Boolean

下单订购后,是否自动从客户的账户中支付; true:自动支付; false:不自动支付。 自动支付时,只能使用账户的现金支付;如果要使用代金券,请选择不自动支付,然后在用户费用中心,选择代金券支付。

缺省值:false

表10 CreateLoadbalancerAutoscalingOption

参数

是否必选

参数类型

描述

enable

Boolean

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

  • true:开启。

  • false:不开启。

缺省值:false

min_l4_flavor_id

String

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

最小长度:1

最大长度:36

min_l7_flavor_id

String

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

最小长度:1

最大长度:36

响应参数

状态码: 201

表11 响应Body参数

参数

参数类型

描述

loadbalancer

LoadBalancer object

负载均衡器对象。(按需场景返回该字段)

loadbalancer_id

String

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

最小长度:0

最大长度:36

order_id

String

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

最小长度:0

最大长度:36

request_id

String

请求ID。

注:自动生成 。

最小长度:0

最大长度:36

表12 LoadBalancer

参数

参数类型

描述

id

String

负载均衡器ID。

description

String

负载均衡器描述信息。

最小长度:1

最大长度:255

provisioning_status

String

负载均衡器的配置状态。取值:

  • ACTIVE:使用中。

  • PENDING_DELETE:删除中。

admin_state_up

Boolean

负载均衡器的管理状态。固定为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

billing_info

String

资源账单信息。 取值:

  • 空:按需计费。

  • 非空:包周期计费,

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

CS2107161019CDJZZ:OFFI569702121789763584:eu-de:057ef081eb00d2732fd1c01a9be75e6f

使用说明:

  • admin权限才能更新此字段。

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

使用说明:

  • 若不指定该字段,则会在当前负载均衡器所在子网作为下联面子网。

  • 若指定多个下联面子网,则按顺序优先使用第一个子网来为负载均衡器下联面端口分配ip地址。

  • 下联面子网必须属于该LB所在的VPC。

  • 不支持边缘云子网。

elb_virsubnet_type

String

下联面子网类型

  • ipv4:ipv4

  • dualstack:双栈

ip_target_enable

Boolean

是否启用跨VPC后端转发。开启跨VPC后端转发后,后端服务器组支持添加其他VPC、其他公有云、云下数据中心的服务器。取值: - true:开启。 - false:不开启。 仅独享型负载均衡器支持该特性。

frozen_scene

String

负载均衡器的冻结场景。若负载均衡器有多个冻结场景,用逗号分隔。取值:

  • POLICE:公安冻结场景。

  • ILLEGAL:违规冻结场景。

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

  • RTNER:合作伙伴冻结(合作伙伴冻结子客户资源)。

  • REAR:欠费冻结场景。

ipv6_bandwidth

BandwidthRef object

带宽对象ID,仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时,此EIP会被分进共享带宽里面。

deletion_protection_enable

Boolean

是否开启删除保护,取值:

  • false:不开启。

  • true:开启。

仅当前局点启用删除保护特性后才会返回该字段。

说明:

退场时需要先关闭所有资源的删除保护开关。

autoscaling

AutoscalingRef object

弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。

使用说明:

  • 仅当局点支持弹性扩缩特性才会返回该字段。

  • 开启弹性扩缩容后,l4_flavor_id和l7_flavor_id不再起作用。

表13 PoolRef

参数

参数类型

描述

id

String

后端服务器组ID。

表14 ListenerRef

参数

参数类型

描述

id

String

监听器ID。

表15 Tag

参数

参数类型

描述

key

String

标签键

最小长度:1

最大长度:36

value

String

标签值

最小长度:0

最大长度:43

表16 EipInfo

参数

参数类型

描述

eip_id

String

eip_id

eip_address

String

eip_address

ip_version

Integer

IP版本号,取值:4表示IPv4,6表示IPv6。

表17 PublicIpInfo

参数

参数类型

描述

publicip_id

String

弹性公网ip配置id

publicip_address

String

IP地址

ip_version

Integer

IP版本信息。 取值:

  • 4:IPv4

  • 6:IPv6

表18 BandwidthRef

参数

参数类型

描述

id

String

共享带宽的id

表19 AutoscalingRef

参数

参数类型

描述

enable

Boolean

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

  • true:开启。

  • false:不开启。

缺省值:false

min_l4_flavor_id

String

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

最小长度:1

最大长度:36

min_l7_flavor_id

String

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

最小长度:1

最大长度:36

请求示例

  • 示例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操作正常返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close