CreateLoadBalancer - Create a GWLB instance - Server Load Balancer

Creates a Gateway Load Balancer (GWLB) instance.

Operation description

Ensure that you fully understand the billing methods and pricing of GWLB before calling this operation.

Creating a GWLB instance automatically creates the AliyunServiceRoleForGwlb service-linked role.
CreateLoadBalancer is asynchronous. After a request is sent, the system returns a request ID and runs the task in the background. Call GetLoadBalancerAttribute to query the instance status.
- If the GWLB instance is in the Provisioning state, the GWLB instance is being created.
- If the GWLB instance is in the Active state, the GWLB 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 GWLB instance name. Must be 2 to 128 characters, start with a letter, and can contain letters, digits, periods (.), underscores (_), and hyphens (-).	testGwlbName
VpcId	string	Yes	The virtual private cloud (VPC) ID.	vpc-uf6qcgpv22ttrnnjh****
ZoneMappings	array<object>	Yes	The zone-to-vSwitch mappings. Specify 1 to 20 zones. If the region supports two or more zones, specify at least two.
	object	No
VSwitchId	string	Yes	The vSwitch ID in the zone. Only one vSwitch per zone is allowed.	vsw-2f0eb020****
ZoneId	string	Yes	The zone ID. Call DescribeZones to query available zones.	cn-hangzhou-a
Tag	array<object>	No	The tags to add to the instance.
	object	No	A tag object. Up to 20 tags per call.
Key	string	No	The tag key. Cannot be empty. Up to 128 characters. Cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	testTagKey
Value	string	No	The tag value. Up to 256 characters. Cannot contain `http://` or `https://`.	testTagValue
ResourceGroupId	string	No	The resource group ID.	rg-acfmwbufq6q3****
DryRun	boolean	No	Whether to perform only a dry run. Valid values: true: validates the request without executing it. Returns `DryRunOperation` on success, or an error code on failure. false (default): validates and executes the request. Returns a 2xx HTTP status code on success.	false
ClientToken	string	No	The client token for idempotency. Must be unique across requests and contain only ASCII characters. Note If not specified, the system uses the request ID as the client token. The request ID may differ for each request.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object
LoadBalancerId	string	The GWLB instance ID.	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.