Build a GWLB Listener with the CreateListener API - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Creates a load balancing listener.

Operation description

The CreateListener operation is asynchronous. After you send the request, the system returns a request ID, but the listener is not yet created and the creation task is still running in the background. You can call the GetListenerAttribute operation to query the creation status of the listener:

When the listener is in the Provisioning state, the listener is being created.
When the listener is in the Running state, the listener 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:CreateListener

create

*LoadBalancer

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

*ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

*Listener

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

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the gateway load balancing instance.	gwlb-te609d6696632f7*****
ListenerDescription	string	No	The custom description of the listener. The description must be 2 to 256 characters in length, and can contain Chinese characters, English letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).	listener-description
ServerGroupId	string	Yes	The ID of the server group.	sgp-ckh01px70dszof****
TcpIdleTimeout	integer	No	The idle timeout period for TCP connections. Valid values: 60 to 6000 seconds. Default value: 350 seconds.	350
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: The system prechecks the request without creating the listener. The system checks whether the required parameters are specified, the request format, and the service limits. If the request fails the precheck, the system returns an error. If the request passes the precheck, the system returns the error code `DryRunOperation`. false (default): The system sends a normal request. If the request passes the precheck, the system returns an HTTP 2xx status code and performs the operation.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among 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****
Tag	array<object>	No	The list of tags. You can add up to 20 tags in a single call.
	object	No	The tag.
Key	string	No	The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length, and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	testKey
Value	string	No	The tag value. The tag value can be up to 256 characters in length, and cannot contain `http://` or `https://`.	testValue

Response elements

Element	Type	Description	Example
	object	The response parameters.
ListenerId	string	The listener ID.	lsn-wi3c0v30ivysrg****
RequestId	string	The request ID.	A045E652-D298-5E70-A978-7247135336FB

Examples

Success response

JSON format

{
  "ListenerId": "lsn-wi3c0v30ivysrg****",
  "RequestId": "A045E652-D298-5E70-A978-7247135336FB"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	Resource %s with business state %s does not support current operation
400	MissingParam.TagKey	The param of TagKey is missing.	The parameter of tag key is missing.
400	MissingParam.TagValue	The param of TagValue is missing.	The parameter of tag value is missing.
400	OperationDenied.TooManyListeners	The operation is not allowed because of TooManyListener.	The number of listeners of the load balancer instance exceeds the limit. The operation is denied.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	Resource %s current state %s does not support operation
400	ResourceInUse.IP	The specified resource of IP is in use.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	The VPC IDs of the two resources do not match.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
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.
400	IllegalParam.TagValue	The param of %s is illegal.	The parameter of tag value is illegal.
400	OperationDenied.TcpIdleTimeoutConflictWithScheduler	The TCP idle timeout of listener must be default value when the scheduling algorithm of server group is not 5TCH.	The TCP idle timeout of listener must be default value when the scheduling algorithm of server group is not 5TCH.
404	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.	The specified resource of .LoadBalancer is not found.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	The specified server group resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.