调用UpdateListenerLogConfig更新监听的日志配置-负载均衡-阿里云

接口说明

UpdateListenerLogConfig 接口属于异步接口，即系统返回一个请求 ID，但该监听的日志配置尚未更新成功，系统后台的更新任务仍在进行。您可以调用 GetListenerAttribute 查询监听的日志配置的更新状态：

当监听器处于 Configuring 状态时，表示监听的日志配置正在更新中。
当监听器处于 Running 状态时，表示监听的日志配置更新成功。

说明

只有开启实例访问日志后，才能更新监听的日志配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alb:UpdateListenerLogConfig

update

*LoadBalancer

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

无

请求参数

名称	类型	必填	描述	示例值
ListenerId	string	是	应用型负载均衡实例监听 ID。	lsn-o4u54y73wq7b******
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	5A2CFF0E-5718-45B5-9D4D-70B******
DryRun	boolean	否	是否只预检此次请求，取值： true：发送检查请求，不会更新监听的日志配置。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回HTTP_2xx状态码并直接进行操作。	true
AccessLogRecordCustomizedHeadersEnabled	boolean	否	访问日志是否开启携带自定义头字段。取值： true：是。 false（默认值）：否。说明只有实例访问日志开关 AccessLogEnabled 打开时，才能设置此参数为 true。	true
AccessLogTracingConfig	object	否	Xtrace 配置信息。
TracingEnabled	boolean	是	Xtrace 功能状态。取值： true：是。 false（默认值）：否。说明只有实例访问日志开关 AccessLogEnabled 打开时，才能设置此参数为 true。	true
TracingSample	integer	否	Xtrace 采样率。取值范围：1~10000。说明 TracingEnabled 为 true 时有效。	100
TracingType	string	否	Xtrace 类型，取值为 Zipkin。说明 TracingEnabled 为 true 时有效。	Zipkin

返回参数

名称	类型	描述	示例值
	object	更新监听的日志配置。
JobId	string	异步任务 ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	请求 ID。	365F4154-92F6-4AE4-92F8-7FF3******

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	资源%s [%s]的业务状态无效。
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.	指定的资源%s正在配置中，请稍后再试。
404	ResourceNotFound.Listener	The specified resource %s is not found.	监听不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。