Updates the log configuration of a listener.
Debugging
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 listener configured for the ALB instance. |
ClientToken | String | No | 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure 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 |
Specifies whether only to precheck the request. Valid values:
|
AccessLogRecordCustomizedHeadersEnabled | Boolean | No | true |
Specifies whether to allow access logs to contain custom headers. Valid values: true and false. Default value: false. Note You can set this parameter to true only if you enable the access log feature for the ALB instance.
|
AccessLogTracingConfig | Object | No |
The configuration information about the Xtrace feature. |
|
TracingEnabled | Boolean | Yes | true |
Specifies whether to enable the Xtrace feature. Valid values: true and false. Default value: false. Note You can set this parameter to true only if you enable the access log feature for the ALB instance.
|
TracingSample | Integer | No | 100 |
The sampling rate of the Xtrace feature. Valid values: 1 to 10000. Note This parameter is valid only if the TracingEnabled parameter is set to true.
|
TracingType | String | No | Zipkin |
The type of Xtrace. Set the value to Zipkin. Note This parameter is valid only if the TracingEnabled parameter is set to true.
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
JobId | String | 72dcd26b-f12d-4c27-b3af-18f6aed5**** |
The ID of the asynchronous 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
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | The error message returned because the service status of the specified %s [%s] resource is invalid. |
400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | The error message returned because the status of the specified %s [%s] resource is invalid. |
400 | IncorrectStatus.Listener | The status of %s [%s] is incorrect. | The error message returned because the status of the specified %s [%s] resource is invalid. |
400 | OperationDenied.AccessLogDisabled | The operation is not allowed because of %s. | The error message returned because the operation is not allowed due to %s. |
404 | ResourceNotFound.Listener | The specified resource %s is not found. | The error message returned because the specified %s resource does not exist. |
For a list of error codes, visit the API Error Center.