UpdateListenerAttribute - Server Load Balancer - Alibaba Cloud Documentation Center

Updates the properties of a listener.

Operation description

The UpdateListenerAttribute operation is asynchronous. After you send a request, the system returns a request ID. The listener configuration is then updated in the background. You can call the GetListenerAttribute operation to query the update status of the listener:

If a listener is in the Configuring state, the listener configuration is being updated.
If a listener is in the Running state, the listener configuration is updated.

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:UpdateListenerAttribute

update

*LoadBalancer

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

*Listener

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

ServerGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	The listener ID.	lsn-lxce8iqbof2vl0****
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	No	The server group ID.	sgp-sp8d2r6y7t0xtl****
TcpIdleTimeout	integer	No	The timeout period of an idle TCP connection. Valid values: 60 to 6000. Unit: seconds.	350
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a normal request. If the request passes the check, 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 token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each request is different.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	7DBFC67C-A272-5952-8287-6C3EBE4E04D9

Examples

Success response

JSON format

{
  "RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9"
}

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	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	Resource %s current state %s does not support operation
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.	Operation not supported for resource% s in current state% s.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	The VPC IDs of the two resources do not match.
400	ResourceInUse.IP	The specified resource of IP is in use.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
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.
400	OperationDenied.TcpIdleTimeoutNotConfigurable	The TCP idle timeout of listener is configurable only when the scheduling algorithm of server group is 5TCH.	The TCP idle timeout of listener is configurable only when the scheduling algorithm of server group is 5TCH.
404	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.	The specified resource of .LoadBalancer is not found.
404	ResourceNotFound.Listener	The specified resource of %s is not found.	The specified resource of %s 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.