UpdateListenerLogConfig - Server Load Balancer - Alibaba Cloud Documentation Center

Updates the log configuration of a listener, such as the access log configuration.

Operation description

UpdateListenerLogConfig 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 GetListenerAttribute to query the status of the task:

If a listener is in the Configuring state, the log configuration of the listener is being modified.
If a listener is in the Running state, the log configuration of the listener is modified.

Note You can update the log configuration of a listener only after you enable the access log feature.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
alb:UpdateListenerLogConfig	Write	LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	The ID of the Application Load Balancer (ALB) listener.	lsr-bp1bpn0kn908w4nbw****
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 request ID as the client token. The request ID may be different for each request.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing 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 message 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.	true
AccessLogRecordCustomizedHeadersEnabled	boolean	No	Specifies whether to record custom headers in the access log. Valid values: true false (default) Note You can set this parameter to true only if the access log feature is enabled by specifying AccessLogEnabled.	true
AccessLogTracingConfig	object	No	The configuration information about the Xtrace feature.
TracingEnabled	boolean	Yes	Specifies whether to enable the Xtrace feature. Valid values: true false (default) Note You can set this parameter to true only if the access log feature is enabled by specifying AccessLogEnabled.	true
TracingSample	integer	No	The sampling rate of the Xtrace feature. Valid values: 1 to 10000. Note This parameter takes effect only if you set TracingEnabled to true.	100
TracingType	string	No	The type of Xtrace. Set the value to Zipkin. Note This parameter takes effect only if you set TracingEnabled to true.	Zipkin

Response parameters

Parameter	Type	Description	Example
	object	The operation to update the configuration of a listener.
JobId	string	The asynchronous task ID.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710

Examples

Sample success responses

JSONformat

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	The business status of %s [%s] is incorrect.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	ResourceInConfiguring.Listener	The specified resource %s is being configured. Please try again later.	-
400	OperationDenied.AccessLogDisabled	The operation is not allowed because of %s.	The operation is not allowed because of %s.
404	ResourceNotFound.Listener	The specified resource %s is not found.	The specified resource %s is not found.

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

Change history

Change time

Summary of changes

Operation

2024-01-29

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	delete Error Codes: 404