CreateLoadBalancer - Create a GWLB instance - Server Load Balancer

Creates a Gateway Load Balancer instance.

Operation description

Before you invoke this operation, make sure that you fully understand the billing methods and pricing of Gateway Load Balancer (GWLB).

When you create a GWLB instance, the system automatically creates the AliyunServiceRoleForGwlb service-linked role for you.
The CreateLoadBalancer operation is asynchronous. The system returns an instance ID, but the GWLB instance is not yet created and the creation task is still running in the background. You can invoke the GetLoadBalancerAttribute operation to query the creation status of the GWLB instance:
- If the GWLB instance is in the Provisioning state, the instance is being created.
- If the GWLB instance is in the Active state, the instance is created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gwlb:CreateLoadBalancer

create

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/*

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

None

Request parameters

Parameter	Type	Required	Description	Example
AddressIpVersion	string	No	The IP version. Valid values: Ipv4 (default): IPv4.	Ipv4
LoadBalancerName	string	No	The name of the GWLB instance. The name must be 2 to 128 characters in length, and can contain letters, Chinese characters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter or a Chinese character.	testGwlbName
VpcId	string	Yes	The ID of the virtual private cloud (VPC).	vpc-uf6qcgpv22ttrnnjh****
ZoneMappings	array<object>	Yes	The zone and vSwitch mappings. You must specify at least one zone and can specify up to 20 zones. If the current region supports two or more zones, specify at least two zones.
	object	No	The zone and vSwitch mapping.
VSwitchId	string	Yes	The vSwitch that corresponds to the zone. You can specify only one vSwitch and one subnet for each zone.	vsw-2f0eb020****
ZoneId	string	Yes	The zone ID. You can invoke the DescribeZones operation of Gateway Load Balancer to obtain the zone ID.	cn-hangzhou-a
Tag	array<object>	No	The tags.
	object	No	The tags. You can specify up to 20 tags in a single call.
Key	string	No	The tag key. The tag key cannot be an empty string. A tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	testTagKey
Value	string	No	The tag value. A tag value can be up to 256 characters in length and cannot contain `http://` or `https://`.	testTagValue
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmwbufq6q3****
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: prechecks the request without creating the instance. The system checks whether required parameters are specified, the request format is valid, and service limits are met. If the request fails the precheck, the corresponding error is returned. If the request passes the precheck, the `DryRunOperation` error code is returned. false (default): sends the request. If the request passes the precheck, an HTTP 2xx status code is returned and the operation is performed.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can generate the value from your client and make sure that the value is unique across different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object
LoadBalancerId	string	The ID of the GWLB instance.	gwlb-9njtjmqt7zfcqm****
RequestId	string	The request ID.	00B19438-66BB-58C3-8C2F-DA5B6F95CBDA

Examples

Success response

JSON format

{
  "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
  "RequestId": "00B19438-66BB-58C3-8C2F-DA5B6F95CBDA"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DuplicatedParam.ZoneId	The param of ZoneId is duplicated.	Duplicate ZoneId parameter in list
400	OperationDenied.VSwitchNotSupportIpv6	The operation is not allowed because of VSwitchNotSupportIpv6.	The operation is not allowed because IPv6 is not enabled for the vSwitch.
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	Insufficient vSwitch IP resources
400	DuplicatedParam.VSwitchId	The param of VSwitchId is duplicated.	Duplicate vSwitchId parameter in list
400	IllegalParamSize.ZoneMappings	The param size of ZoneMappings is illegal.	Illegal number of ZoneMappings lists
400	Mismatch.ZoneIdAndVSwitchId	The ZoneId and VSwitchId are mismatched.	The value of the ZoneId parameter does not match that of the vSwitchId
400	QuotaExceeded.LoadBalancersNum	The quota of %s is exceeded for resource %s, usage %s/%s.	The quota gwlb_quota_loadbalancers_num has exceeded the quota limit.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.