Call UpdateListenerLogConfig to modify listener log configuration - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Operation description

UpdateListenerLogConfig is an asynchronous operation. After a request ID is returned, the log configuration of the listener is not yet updated, and the system continues to process the update task in the background. You can call GetListenerAttribute to query the update status of the listener log configuration:

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

Note

You can update the log configuration of a listener only after you enable access logging for the instance.

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

alb:UpdateListenerLogConfig

update

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	The ID of the Application Load Balancer (ALB) instance listener.	lsn-o4u54y73wq7b******
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 API request as the ClientToken. The RequestId may be different for each API request.	5A2CFF0E-5718-45B5-9D4D-70B******
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 log configuration of the listener is not updated. 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, an HTTP_2xx status code is returned and the operation is performed.	true
AccessLogRecordCustomizedHeadersEnabled	boolean	No	Specifies whether to include custom header fields in access logs. Valid values: true: includes custom header fields. false (default): does not include custom header fields. Note You can set this parameter to true only when the access logging switch AccessLogEnabled is turned on for the instance.	true
AccessLogTracingConfig	object	No	The Xtrace configuration information.
TracingEnabled	boolean	Yes	The status of the Xtrace feature. Valid values: true: enabled. false (default): disabled. Note You can set this parameter to true only when the access logging switch AccessLogEnabled is turned on for the instance.	true
TracingSample	integer	No	The Xtrace sampling rate. Valid values: 1 to 10000. Note This parameter takes effect only when TracingEnabled is set to true.	100
TracingType	string	No	The type of Xtrace. Valid values: Zipkin and OpenTelemetry. Note This parameter takes effect only when TracingEnabled is set to true.	Zipkin

Response elements

Element	Type	Description	Example
	object	The log configuration of the listener.
JobId	string	The asynchronous task ID.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF3******

Examples

Success response

JSON format

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

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 current status of the instance does not support this operation.
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.	The current status of the listener does not support this operation.
400	OperationDenied.AccessLogDisabled	The operation is not allowed because of %s.	The operation is denied because access logging is not enabled for the instance.
400	ResourceInConfiguring.Listener	The specified resource of %s is being configured, please try again later.	The specified resource of %s is being configured, please try again later.
404	ResourceNotFound.Listener	The specified resource %s is not found.	The listener does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.