Updates the log configuration of a listener.

Note You can call this operation only if you enable access logs for Application Load Balancer (ALB) instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateListenerLogConfig

The operation that you want to perform.

Set the value to UpdateListenerLogConfig.

ListenerId String Yes lsr-bp1bpn0kn908w4nbw****

The ID of the ALB instance listener.

ClientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

The client token that is used to ensure the idempotency. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

DryRun Boolean No true

Specify whether to precheck this request. Valid values:

  • true: prechecks the API request. Resources are not created. The system checks the required parameters, request format and service limits. If the request fails the check, the corresponding error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): checks the request. After the request passes the check, an HTTP_2xx status code is returned and the operation is performed.
AccessLogRecordCustomizedHeadersEnabled Boolean No true

Specifies whether the access log has a custom header field.

Valid values: true and false.

Default value: false.

Note Only if the AccessLogEnabled parameter is set to true, you can set this parameter to true.
AccessLogTracingConfig Object No

The configuration information about the Xtrace feature.

TracingEnabled Boolean No true

The state of the Xtrace feature.

Valid values: true and false.

Default value: false.

Note Only if the AccessLogEnabled parameter is set to true, you can set this parameter to true.
TracingSample Integer No 100

The sampling rate of the Xtrace feature.

Valid values: 1 to 10000.

Note Only if TracingEnabled is set to true, this parameter is valid.
TracingType String No Zipkin

The type of Xtrace. Set the value to Zipkin.

Note Only if TracingEnabled is set to true, this parameter is valid.

Response parameters

Parameter Type Example Description
JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

The ID of the query task.

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateListenerLogConfig
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&DryRun=true
&AccessLogRecordCustomizedHeadersEnabled=true
&AccessLogTracingConfig={"TracingEnabled":true,"TracingSample":100,"TracingType":"Zipkin"}
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateListenerLogConfigResponse>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
</UpdateListenerLogConfigResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 IncorrectBusinessStatus.LoadBalancer The business status of %s [%s]  is incorrect. The error message returned because the business status of the specified resource %s [%s] is invalid.
400 IncorrectStatus.LoadBalancer The status of %s [%s] is incorrect. The error message returned because the status of the specified resource %s [%s] is invalid.
400 IncorrectStatus.Listener The status of %s [%s] is incorrect. The error message returned because the status of the specified resource %s [%s] is invalid.
400 OperationDenied.AccessLogDisabled The operation is not allowed because of %s. The error message returned because the operation is not allowed because of %s.
404 ResourceNotFound.Listener The specified resource %s is not found. The error message returned because the specified resource %s does not exist.

For a list of error codes, visit the API Error Center.