UpdateListenerLogConfig - Server Load Balancer - Alibaba Cloud Documentation Center

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.

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) 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 request ID as the client token. The request ID may be different for each 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 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 elements

Element	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-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.
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.
400	OperationDenied.AccessLogDisabled	The operation is not allowed because of %s.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.