Creating a Load Balancer

Function

This API is used to create a dedicated load balancer.

When you create a load balancer, note the following:

Specify vip_subnet_cidr_id if you want to bind a private IPv4 address to the load balancer.
Specify publicip and either vpc_id or vip_subnet_cidr_id if you want to bind a new IPv4 EIP to the load balancer.
Specify publicip_ids and either vpc_id or vip_subnet_cidr_id if you want to bind an existing IPv4 EIP to the load balancer.
Specify ipv6_vip_virsubnet_id if you want to bind a private IPv6 address to the load balancer.
Specify both ipv6_vip_virsubnet_id and ipv6_bandwidth if you want to bind a public IPv6 address to the load balancer.
Specify l4_flavor_id if you want to create a network load balancer and l7_flavor_id to create an application load balancer. Specify both l4_flavor_id and l7_flavor_id if you want to create a load balancer that can work at both Layer 4 and Layer 7.
If prepaid_options is not specified, pay-per-use load balancers will be created, which are billed by fixed specifications or elastic specifications you have selected for l4_flavor_id and l7_flavor_id when creating the load balancer.
If you want to create a gateway load balancer, note the following:
- Set loadbalancer_type to gateway and do not specify vip_address and ipv6_vip_address.
Specify either vip_subnet_cidr_id or ipv6_subnet_cidr_id, or both. If they are both specified, they must be the same subnet.
You cannot bind an EIP to gateway load balancers.
Specify gw_flavor_id if you need a given flavor.

Constraints

There are some constraints when you create a load balancer:

vpc_id, vip_subnet_cidr_id, and ipv6_vip_virsubnet_id cannot be left blank at the same time.
ip_target_enable specifies whether to enable IP as a Backend. If you set it to true, you can associate servers in a VPC connected through a VPC peering connection, in a VPC connected through a cloud connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using server IP addresses. If you set it to false, the load balancer and the backend servers must be in the same VPC.
admin_state_up must be true.
provider must be set to vlb.
elb_virsubnet_ids indicates the subnets that support IPv4/IPv6 dual stack or only IPv4. If only IPv4 subnets are supported, ipv6_vip_virsubnet_id must be left blank.
You can unbind the EIP only on the ELB console. Locate the load balancer in the load balancer list and click More > Unbind EIP in the Operation column.
publicip_ids and publicip cannot be specified at the same time. Set either publicip_ids to bind an existing EIP to the load balancer, or publicip to bind a new EIP to the load balancer, or neither of them.
If you want to add the load balancer to an existing shared bandwidth, you must specify the ID of the shared bandwidth. If you want the load balancer to use a new dedicated bandwidth, charge_mode, share_type, and size are required.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/elb/loadbalancers

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
loadbalancer	Yes	CreateLoadBalancerOption object	Definition: Specifies the parameters for creating a load balancer. Constraints: N/A Range: N/A Default value: N/A

**Table 4** CreateLoadBalancerOption
Parameter	Mandatory	Type	Description
project_id	No	String	Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A NOTE: This parameter is invalid. The project ID in the URL is used.
name	No	String	Definition: Specifies the load balancer name. Constraints: N/A Range: The value can contain a maximum of Unicode 255 characters, including letters and more. It can be left blank. Default value: N/A
description	No	String	Definition: Provides supplementary information about the load balancer. Constraints: N/A Range: The value can contain a maximum of Unicode 255 characters, including letters and more. It can be left blank. Default value: N/A
vip_address	No	String	Definition: Specifies the private IPv4 address of the load balancer. The IP address must be from the IPv4 subnet where the load balancer resides and should not be used by other services. Constraints: vip_subnet_cidr_id is also required if vip_address is specified. If only vip_subnet_cidr_id is specified, the system will automatically assign a private IPv4 address to the load balancer. If neither vip_address nor vip_subnet_cidr_id is specified, no private IPv4 address will be assigned, and the value of vip_address will be null. vip_address cannot be specified for gateway load balancers. Range: The IP address must be in [0-255].[0-255].[0-255].[0-255] format, for example, 192.168.1.1. Default value: N/A
vip_subnet_cidr_id	No	String	Definition: Specifies the ID of the IPv4 subnet where the load balancer is located. This subnet is also called the frontend subnet. Constraints: This parameter is mandatory if you need to create a load balancer with a private IPv4 address. You can query parameter neutron_subnet_id in the response by calling the VPC API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets). vpc_id, vip_subnet_cidr_id, and ipv6_vip_virsubnet_id cannot be left blank at the same time. The subnet specified by vip_subnet_cidr_id and the subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id. The subnet specified by vip_subnet_cidr_id must be in the VPC specified by vpc_id if both vpc_id and vip_subnet_cidr_id are specified. vip_subnet_cidr_id and ipv6_vip_virsubnet_id cannot be left blank at the same time when you create gateway load balancers. Their values must be the IPv4 subnet ID and IPv6 network ID of the same subnet. Range: The ID must be in UUID format and can contain up to 36 characters. Default value: N/A
ipv6_vip_virsubnet_id	No	String	Definition: Specifies the ID of the IPv6 subnet where the load balancer is located. This subnet is also called the frontend subnet. Constraints: This parameter is mandatory if you need to create a load balancer with a private IPv6 address. You can query parameter neutron_network_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets). vpc_id, vip_subnet_cidr_id, and ipv6_vip_virsubnet_id cannot be left blank at the same time. The subnet specified by vip_subnet_cidr_id and the subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id. IPv6 must have been enabled for the subnet where the load balancer resides. vip_subnet_cidr_id and ipv6_vip_virsubnet_id cannot be left blank at the same time when you create gateway load balancers. Their values must be the IPv4 subnet ID and IPv6 network ID of the same subnet. Range: The ID must be in UUID format and can contain up to 36 characters. Default value: N/A
provider	No	String	Definition: Specifies the provider of the load balancer. The value can only be vlb and does not need to be specified.
l4_flavor_id	No	String	Definition: Specifies the ID of a flavor at Layer 4. Constraints: You can query parameter id in the response by calling the API (GET https://{ELB_Endpoint}/v3/{project_id}/elb/flavors?type=L4). If neither l4_flavor_id nor l7_flavor_id is specified, the default flavor is used. The default flavor varies by site. If the flavor type is L4, the load balancer uses the fixed flavors and will be billed by the flavor you select. If the flavor type is L4_elastic_max, the load balancer uses the elastic flavors and will be billed by how many LCUs you use. This parameter is not supported by gateway load balancers. Range: The ID must be in UUID format and can contain up to 36 characters. Default value: N/A
l7_flavor_id	No	String	Definition: Specifies the ID of a flavor at Layer 7. Constraints: You can query parameter id in the response by calling the API (GET https://{ELB_Endpoint}/v3/{project_id}/elb/flavors?type=L7). If neither l4_flavor_id nor l7_flavor_id is specified, the default flavor is used. The default flavor varies by site. If the flavor type is L7, the load balancer uses the fixed flavors and will be billed by the flavor you select. If the flavor type is L7_elastic_max, the load balancer uses the elastic flavors and will be billed by how many LCUs you use. This parameter is not supported by gateway load balancers. Range: The ID must be in UUID format and can contain up to 36 characters. Default value: N/A
gw_flavor_id	No	String	Definition: Specifies the flavor ID of the gateway load balancer. Constraints: N/A Range: If gw_flavor_id is not specified, the default flavor is used. The default flavor varies by site. Default value: N/A
guaranteed	No	Boolean	Definition: Specifies whether to create a shared or dedicated load balancer. Currently, the value can only be true. If the value is set to false, 400 Bad Request will be returned. Range: true: Dedicated load balancers will be created. false: Shared load balancers will be created. Default value: true
loadbalancer_type	No	String	Definition: Specifies the load balancer type. Constraints: N/A Range: gateway: gateway load balancers null: other types of load balancers Default value: null
vpc_id	No	String	Definition: Specifies the ID of the VPC where the load balancer is located. Constraints: You can query parameter id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/vpcs). vpc_id, vip_subnet_cidr_id, and ipv6_vip_virsubnet_id cannot be left blank at the same time. The subnet specified by vip_subnet_cidr_id and the subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id. Range: The ID must be in UUID format and can contain up to 36 characters. Default value: N/A
availability_zone_list	Yes	Array of strings	Definition: Specifies the list of AZs where the load balancers are created. You can query the AZs by calling the API (GET https://{ELB_Endpoint}/v3/{project_id}/elb/availability-zones). Select one or more AZs in the same set. Constraints: N/A Range: N/A Default value: N/A NOTE: If disaster recovery is required, you are advised to select multiple AZs.
enterprise_project_id	No	String	Definition: Specifies the ID of the enterprise project. If no enterprise project ID is specified during resource creation, 0 is returned, indicating that the resource belongs to the default enterprise project. Constraints: The enterprise project ID cannot be "", 0, or an enterprise project ID that does not exist. Range: N/A Default value: 0
tags	No	Array of Tag objects	Definition: Specifies the tags added to the load balancer. Example: "tags":[{"key":"my_tag","value":"my_tag_value"}] Constraints: N/A Range: N/A Default value: N/A
admin_state_up	No	Boolean	Definition: Specifies whether the load balancer is enabled. Constraints: N/A Range: true: enabled false: disabled Default value: true
ipv6_bandwidth	No	BandwidthRef object	Definition: Specifies the ID of the bandwidth object. Constraints: This parameter is available only when you create or update a load balancer with a public address. If you bind a new EIP to the load balancer and specify a shared bandwidth, this EIP will be added to the shared bandwidth. Default value: N/A Default value: N/A
publicip_ids	No	Array of strings	Definition: Specifies the IDs of the EIPs bound to the load balancer. Constraints: Only the first EIP in the array will be bound. This parameter is not supported by gateway load balancers. Range: N/A Default value: N/A
publicip	No	CreateLoadBalancerPublicIpOption object	Definition: Specifies the request parameters for binding a new EIP to the load balancer. Constraints: N/A Default value: N/A Default value: N/A
elb_virsubnet_ids	No	Array of strings	Definition: (OpenStack Neutron API) Specifies the network IDs of backend subnets where the load balancers work. A load balancer uses IP addresses in the backend subnet to communicate with backend servers (such as in health check and FullNAT scenarios). You can query parameter neutron_network_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets?vpc_id=xxxx). Constraints: The backend subnet must in the VPC where the load balancer works. You need to specify a backend subnet for the load balancer and add rules to the security group associated with the backend server to allow access from the backend subnet. If there is more than one subnet, the first subnet in the list will be used to assign IP addresses. If this parameter is not specified, the network IDs will be used based on the following rules: If IPv6 is enabled for a load balancer, the network IDs of subnets specified in ipv6_vip_virsubnet_id will be used. If IPv6 is not enabled for a load balancer, the network IDs of subnets specified in vip_subnet_cidr_id will be used. If a load balancer only works on the public network, any subnet in the VPC where the load balancer is deployed will be used. The subnet with the most available IP addresses is preferred. A load balancer uses IP addresses in the backend subnet to communicate with backend servers (such as in health check, and FullNAT scenarios). To prevent traffic from being blocked by the security groups associated with backend servers, add security group rules to allow access from the backend subnet of the load balancer to backend servers. In the elastic scaling scenario, the reserved IP addresses may change. It is recommended that you should add security group rules to allow access from the backend subnet of the load balancer instead of only allowing certain IP addresses. You are advised to use a dedicated subnet with sufficient IP addresses for easier O&M. Range: N/A Default value: N/A
ip_target_enable	No	Boolean	Definition: Specifies whether to add backend servers that are not in the load balancer's VPC. If you set it to true, you can associate servers in a VPC connected through a VPC peering connection, in a VPC connected through a cloud connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using server IP addresses. Constraints: This function cannot be disabled once it is enabled. If you want to enable IP as a Backend for a load balancer in a shared VPC, ensure that a VPC peering connection has been created to connect the VPCs. Otherwise, the communication will fail. This function is not supported by gateway load balancers. Range: true: This option will be enabled. false: This option will be disabled. Default value: false
deletion_protection_enable	No	Boolean	Definition: Specifies whether to enable deletion protection for the load balancer. Constraints: Before deleting a load balancer, you need to disable deletion protection first. Range: false: This option will not be enabled. true: This option will be enabled. Default value: false
autoscaling	No	CreateLoadbalancerAutoscalingOption object	Definition: Specifies information about elastic scaling. If elastic scaling is enabled, the load balancer flavors can be automatically adjusted based on incoming traffic. Constraints: This parameter is only available for whitelisted users. If elastic scaling is enabled, l4_flavor_id indicates the ID of the maximum elastic flavor at Layer 4. l7_flavor_id indicates the ID of the maximum elastic flavor at Layer 7. Default value: N/A Default value: N/A This parameter is unsupported. Please do not use it.
ipv6_vip_address	No	String	Definition: Specifies the IPv6 address used by the load balancer. Constraints: The IPv6 address must be one in the subnet defined by ipv6_vip_virsubnet_id. Subnets defined by elb_virsubnet_ids must support IPv4/IPv6 dual stack. ipv6_vip_address is not supported by gateway load balancers. Range: N/A Default value: N/A

**Table 5** Tag
Parameter	Mandatory	Type	Description
key	No	String	Definition: Specifies the tag key. Range: N/A
value	No	String	Definition: Specifies the tag value. Range: N/A

**Table 6** BandwidthRef
Parameter	Mandatory	Type	Description
id	Yes	String	Definition: Specifies the ID of the shared bandwidth. Constraints: N/A Range: N/A Default value: N/A

**Table 7** CreateLoadBalancerPublicIpOption
Parameter	Mandatory	Type	Description
ip_version	No	Integer	Definition: Specifies the IP address version. Constraints: N/A Range: 4: IPv4 addresses 6: IPv6 addresses Default value: 4
network_type	Yes	String	Definition: Specifies the EIP type. The default value is 5_bgp. For more information, see the API for assigning an EIP in the Virtual Private Cloud API Reference. Range: 5_bgp Default value: 5_bgp
billing_info	No	String	Definition: Provides billing information about the EIP. Constraints: If the value is left blank, the resource is billed on a pay-per-use basis. Range: N/A Default value: N/A This parameter is unsupported. Please do not use it.
description	No	String	Definition: Provides supplementary information about the EIP. Constraints: N/A Range: N/A Default value: N/A
bandwidth	Yes	CreateLoadBalancerBandwidthOption object	Definition: Provides supplementary information about the bandwidth. Constraints: N/A Default value: N/A Default value: N/A

**Table 8** CreateLoadBalancerBandwidthOption
Parameter	Mandatory	Type	Description
name	No	String	Definition: Specifies the bandwidth name. Constraints: This parameter is mandatory if share_type is set to PER. This parameter will be ignored if the bandwidth reference has a specific ID. Range: The value can contain 1 to 64 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). Default value: N/A
size	No	Integer	Definition: Specifies the bandwidth size. Constraints: This parameter is mandatory if id is set to null. The minimum increment for bandwidth adjustment varies by bandwidth range. The details are as follows: The minimum increment is 1 Mbit/s if the bandwidth range is from 0 Mbit/s to 300 Mbit/s. The minimum increment is 50 Mbit/s if the bandwidth range is from 301 Mbit/s to 1,000 Mbit/s. The minimum increment is 500 Mbit/s if the bandwidth is greater than 1,000 Mbit/s. Range: The default value ranges from 1 Mbit/s to 2,000 Mbit/s, which may vary by region and can be viewed on the management console. Default value: N/A
charge_mode	No	String	Definition: Specifies how the bandwidth used by the EIP is billed. Constraints: This parameter is mandatory if id is set to null. Currently, the bandwidth can be billed only by traffic. Range: bandwidth: billed by bandwidth traffic: billed by traffic Default value: N/A
share_type	No	String	Definition: Specifies the bandwidth type. Constraints: This parameter is mandatory when id is set to null. It will be ignored if the value of id is not null. The bandwidth ID must be specified if the bandwidth type is set to WHOLE. The bandwidth type cannot be WHOLE for IPv6 EIPs. Range: PER: dedicated bandwidths WHOLE: shared bandwidths Default value: N/A
billing_info	No	String	Definition: Provides resource billing information. Range: N/A Default value: N/A This parameter is unsupported. Please do not use it.
id	No	String	Definition: Specifies the ID of the shared bandwidth. An existing shared bandwidth is used. Constraints: The ID must be an existing shared bandwidth ID. There is no need to specify this parameter if the billing mode is yearly/monthly. This parameter will be ignored if it is left blank. Range: N/A Default value: N/A

**Table 9** CreateLoadbalancerAutoscalingOption
Parameter	Mandatory	Type	Description
enable	Yes	Boolean	Definition: Specifies whether to enable elastic scaling for the load balancer. Constraints: N/A Range: true: This option will be enabled. false: This option will be disabled. Default value: N/A This parameter is not supported by gateway load balancers.
min_l7_flavor_id	No	String	Definition: Specifies the ID of the minimum elastic flavor at Layer 7. Constraints: N/A Range: N/A Default value: N/A

Response Parameters

Status code: 201

**Table 10** Response body parameters
Parameter	Type	Description
loadbalancer	LoadBalancer object	Definition: Specifies the load balancer. Range: N/A
request_id	String	Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-).

**Table 11** LoadBalancer
Parameter	Type	Description
id	String	Definition: Specifies the load balancer ID. Range: N/A
description	String	Definition: Provides supplementary information about the load balancer. Range: N/A
provisioning_status	String	Definition: Specifies the provisioning status of the load balancer. Range: ACTIVE: in use PENDING_DELETE: deleting
admin_state_up	Boolean	Definition: Specifies whether the load balancer is enabled. Range: true: enabled false: disabled
provider	String	Definition: Specifies the provider of the load balancer. The value is fixed to vlb. Range: N/A
pools	Array of PoolRef objects	Definition: Lists the IDs of backend server groups associated with the load balancer. Range: N/A
listeners	Array of ListenerRef objects	Definition: Lists the IDs of listeners associated with the load balancer. Range: N/A
operating_status	String	Definition: Specifies the operating status of the load balancer. Range: ONLINE: The load balancer is online. FROZEN: The load balancer is frozen.
name	String	Definition: Specifies the load balancer name. Range: N/A
project_id	String	Definition: Specifies the ID of the project where the load balancer is used. Range: N/A
vip_subnet_cidr_id	String	Definition: Specifies the ID of the IPv4 subnet where the load balancer is located. This subnet is also called the frontend subnet. Range: N/A
vip_address	String	Definition: Specifies the private IPv4 address of the load balancer. Range: N/A
vip_port_id	String	Definition: Specifies the ID of the port bound to the private IPv4 address of the load balancer. Range: N/A
tags	Array of Tag objects	Definition: Specifies the tags added to the load balancer. Range: N/A
created_at	String	Definition: Specifies the time when the load balancer was created. Range: The value must be in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.
updated_at	String	Definition: Specifies the time when the load balancer was updated. Range: The value must be in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.
guaranteed	Boolean	Definition: Specifies whether the load balancer is a dedicated load balancer. Range: false: The load balancer is a shared load balancer. true: The load balancer is a dedicated load balancer.
vpc_id	String	Definition: Specifies the ID of the VPC where the load balancer is located. Range: N/A
eips	Array of EipInfo objects	Definition: Specifies the EIP bound to the load balancer. Range: N/A NOTE: This parameter has the same meaning as publicips.
ipv6_vip_address	String	Definition: Specifies the IPv6 address of the load balancer. Range: N/A
ipv6_vip_virsubnet_id	String	Definition: Specifies the ID of the IPv6 subnet where the load balancer is located. This subnet is also called the frontend subnet. Range: N/A
ipv6_vip_port_id	String	Definition: Specifies the ID of the port bound to the IPv6 address of the load balancer. Range: N/A
availability_zone_list	Array of strings	Definition: Specifies the list of AZs where the load balancers are created. Range: N/A
enterprise_project_id	String	Definition: Specifies the ID of the enterprise project. Range: 0: The resource belongs to the default enterprise project. A string in UUID format indicates a non-default enterprise project.
billing_info	String	Definition: Provides resource billing information. Range: If the value is left blank, the resource is billed on a pay-per-use basis. This parameter is unsupported. Please do not use it.
l4_flavor_id	String	Definition: Specifies the ID of a flavor at Layer 4. If the current load balancer is an elastic flavor instance, this parameter defines the maximum elastic flavor at Layer 4. Range: N/A
l4_scale_flavor_id	String	Definition: Specifies the ID of an elastic flavor at Layer 4. Range: N/A NOTE: This parameter has been discarded. Do not use it.
l7_flavor_id	String	Definition: Specifies the ID of a flavor at Layer 7. If the current load balancer is an elastic flavor instance, this parameter defines the maximum elastic flavor at Layer 7. Range: N/A
l7_scale_flavor_id	String	Definition: Specifies the ID of an elastic flavor at Layer 7. Range: N/A NOTE: This parameter has been discarded. Do not use it.
gw_flavor_id	String	Definition: Specifies the flavor ID of the gateway load balancer. Range: N/A This parameter is unsupported. Please do not use it.
loadbalancer_type	String	Definition: Specifies the load balancer type. Range: gateway: gateway load balancers null: other types of load balancers This parameter is unsupported. Please do not use it.
publicips	Array of PublicIpInfo objects	Definition: Specifies the EIP bound to the load balancer. Range: N/A NOTE: This parameter has the same meaning as eips.
global_eips	Array of GlobalEipInfo objects	Definition: Specifies the global EIP bound to the load balancer. Range: N/A This parameter is unsupported. Please do not use it.
elb_virsubnet_ids	Array of strings	Definition: Specifies the network IDs of subnets on the downstream plane. Range: N/A
elb_virsubnet_type	String	Definition: Specifies the type of the subnet on the downstream plane. Range: ipv4: IPv4 subnets dualstack: subnets that support IPv4/IPv6 dual stack
ip_target_enable	Boolean	Definition: Specifies whether to add backend servers that are not in the load balancer's VPC. If you set it to true, you can associate servers in a VPC connected through a VPC peering connection, in a VPC connected through a cloud connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using server IP addresses. Range: true: This option will be enabled. false: This option will be disabled.
frozen_scene	String	Definition: Specifies the scenario where the load balancer is frozen. If there are multiple scenarios, separate them with commas (,). Range: POLICE: The load balancer is frozen due to security reasons. ILLEGAL: The load balancer is frozen due to violation of laws and regulations. VERIFY: Your account has not completed real-name authentication. PARTNER: The load balancer is frozen by the partner. AREAR: The load balancer is frozen due to arrears. This parameter is unsupported. Please do not use it.
deletion_protection_enable	Boolean	Definition: Specifies whether to enable deletion protection. This parameter is returned only when the deletion protection is enabled in the current region. Range: false: This option will be disabled. true: This option will be enabled. This parameter is unsupported. Please do not use it.
autoscaling	AutoscalingRef object	Definition: Specifies information about elastic scaling. If elastic scaling is enabled, the load balancer flavors can be automatically adjusted based on incoming traffic. Default value: N/A This parameter is unsupported. Please do not use it.
public_border_group	String	Definition: Specifies the public border group. Range: center: public border group of the central site Edge site name: public border group of an edge site This parameter is unsupported. Please do not use it.
charge_mode	String	Definition: Specifies the charge mode of the load balancer. Range: flavor: billed by the fixed flavor you select. lcu: billed by how many LCUs you have used. Null: If it is a shared load balancer, it is free. If it is a dedicated load balancer, it will be billed by the fixed flavor you select. This parameter is unsupported. Please do not use it.
service_lb_mode	String	Definition: Specifies load balancer mode. Range: lb: Cross-tenant access is not supported. ep: Cross-tenant access is supported. This parameter is unsupported. Please do not use it.
instance_type	String	Definition: Specifies the internal service to which the load balancer belongs. Range: N/A This parameter is unsupported. Please do not use it.
instance_id	String	Definition: Specifies the ID of the instance with which the load balancer is associated. Range: N/A This parameter is unsupported. Please do not use it.
proxy_protocol_extensions	Array of ProxyProtocolExtension objects	Definition: Specifies the proxy protocol extension. Range: N/A This parameter is unsupported. Please do not use it.
waf_failure_action	String	Definition: Specifies traffic distributing policies when the WAF is faulty. Range: discard indicates traffic will not be distributed. forward indicates traffic will be distributed to the default backend servers. This parameter is unsupported. Please do not use it.
log_group_id	String	Definition: Specifies the ID of the log group that is associated with the load balancer. Range: N/A
log_topic_id	String	Definition: Specifies the ID of the log topic that is associated with the load balancer. Range: N/A

**Table 12** PoolRef
Parameter	Type	Description
id	String	Definition: Specifies the backend server group ID. Range: N/A

**Table 13** ListenerRef
Parameter	Type	Description
id	String	Definition: Specifies the listener ID. Range: N/A

**Table 14** Tag
Parameter	Type	Description
key	String	Definition: Specifies the tag key. Range: N/A
value	String	Definition: Specifies the tag value. Range: N/A

**Table 15** EipInfo
Parameter	Type	Description
eip_id	String	Definition: Specifies the EIP ID. Range: N/A
eip_address	String	Definition: Specifies the EIP. Range: N/A
ip_version	Integer	Definition: Specifies the IP address version. Range: 4: IPv4 addresses 6: IPv6 addresses

**Table 16** PublicIpInfo
Parameter	Type	Description
publicip_id	String	Definition: Specifies the EIP ID. Range: N/A
publicip_address	String	Definition: Specifies the EIP. Range: N/A
ip_version	Integer	Definition: Specifies the IP address version. Range: 4: IPv4 address 6: IPv6 address

**Table 17** GlobalEipInfo
Parameter	Type	Description
global_eip_id	String	Definition: Specifies the ID of the global EIP. Range: N/A
global_eip_address	String	Definition: Specifies the global EIP. Range: N/A
ip_version	Integer	Definition: Specifies the IP address version. Range: 4: IPv4 addresses 6: IPv6 addresses

**Table 18** AutoscalingRef
Parameter	Type	Description
enable	Boolean	Definition: Specifies whether to enable elastic scaling for the load balancer. Range: true: This option will be enabled. false: This option will be disabled.
min_l7_flavor_id	String	Definition: Specifies the ID of the minimum elastic flavor at Layer 7. Range: N/A

**Table 19** ProxyProtocolExtension
Parameter	Type	Description
vip_address	String	Definition: Specifies the IPv4 address. Constraints: N/A Range: N/A Default value: N/A
ipv6_vip_address	String	Definition: Specifies the IPv6 address. Constraints: N/A Range: N/A Default value: N/A
extension	Extension object	Definition: Specifies the proxy protocol extension. Constraints: N/A Range: N/A Default value: N/A

**Table 20** Extension
Parameter	Type	Description
ep_id	String	Definition: Specifies the VPC endpoint ID. Constraints: N/A Range: N/A Default value: N/A
ep_service_id	String	Definition: Specifies the VPC endpoint service ID. Constraints: N/A Range: N/A Default value: N/A

Example Requests

Example 1: Creating a load balancer with a private IPv4 address

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" ]
  }
}

Example 2: Creating a load balancer with an IPv4 EIP

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"
  }
}

Example 3: Creating a gateway load balancer

POST https://{ELB_Endpoint}/v3/060576798a80d5762fafc01a9b5eedc7/elb/loadbalancers

{
  "loadbalancer" : {
    "name" : "loadbalancer",
    "description" : "simple gateway lb",
    "loadbalancer_type" : "gateway",
    "gw_flavor_id" : "2e859438-7cbb-417b-8f3b-5f618ca76a52",
    "vip_subnet_cidr_id" : "1992ec06-f364-4ae3-b936-6a8cc24633b7",
    "ipv6_vip_virsubnet_id" : "8e7aac33-0d87-4cb2-9cce-2856615d607f",
    "admin_state_up" : true,
    "availability_zone_list" : [ "AZ1" ]
  }
}

Example Responses

Status code: 201

Successful request.

{
  "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"
}