CreateListener - Server Load Balancer - Alibaba Cloud Documentation Center

Creates a listener for a Gateway Load Balancer (GWLB) instance.

Operation description

CreateListener is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetListenerAttribute operation to query the status of the task.

If the listener is in the Provisioning state, the listener is being created.
If the listener is in the Running state, the listener is running.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gwlb:CreateListener	create	LoadBalancer `acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}` ServerGroup `acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}` Listener `acs:gwlb:{#regionId}:{#accountId}:listener/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The GWLB instance ID.	gwlb-te609d6696632f7*****
ListenerDescription	string	No	The description of the listener. The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).	listener-description
ServerGroupId	string	Yes	The server group ID.	sgp-ckh01px70dszof****
DryRun	boolean	No	Specifies whether to perform a dry run, without sending the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP 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 use the client to generate the token, but you must make sure that the token 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 request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-42665544****
Tag	array<object>	No	The tags. You can specify at most 20 tags in each call.
TagModel	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 `acs:` or `aliyun`. The tag key cannot 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 parameters

Parameter	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

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.