调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。	waf_v3prepaid_public_cn-uax****3k0e
FieldList	string	是	需投递的日志字段列表。使用"a,b,c,……"格式表示。说明需要包含所有必选日志字段, 您可以通过调用 DescribeCommonLogFields 接口查看 WAF 日志服务支持的日志字段信息。当日志字段中包含 request_header时，需要使用投递扩展配置（ExtendConfig）参数指定需要投递的请求头。	account,acl_action,acl_rule_id,acl_rule_type,acl_test,antiscan_action,antiscan_rule_id,antiscan_rule_type,antiscan_test,body_bytes_sent,bypass_matched_ids
ExtendConfig	string	否	日志投递扩展配置。以一系列参数构造的 JSON 格式转化成字符串。说明详细信息，请参见日志投递扩展配置参数描述。	{\"request_header\":\"Ali-Cdn-Real-Ip\"}
DeliveryType	string	是	日志投递类型。取值： sls：表示阿里云日志服务。 kafka：表示外发投递到 kafka 日志。 syslog：表示外发投递到 syslog 日志。	sls
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
Resource	string	是	要修改的防护对象。	cwaf-***-waf
LogDeliveryStrategy	string	否	日志投递策略，支持多个策略。以一系列参数构造的 JSON 数组格式转化成字符串。说明详细信息，请参见日志投递策略参数描述。	[{\"logType\":\"blockLog\",\"rate\":100},{\"logType\":\"normalRequestLog\",\"rate\":100},{\"logType\":\"checkLog\",\"rate\":100}]

日志投递策略（LogDeliveryStrategy）参数描述

参数描述

名称	类型	是否必选	示例值	描述
logType	String	必选	blockLog	日志类型。取值： - blockLog：表示拦截日志。 - normalRequestLog：表示正常请求日志。 - checkLog：表示检测日志。
rate	Integer	必选	90	日志采样比。取值范围为[1-100]。

日志投递扩展配置（ExtendConfig）参数描述

参数描述

名称	类型	是否必选	示例值	描述
request_header	String	必选	blockLog	日志投递的请求头。最多支持 5 个，使用"a,b,c,……"格式表示。重要当投递日志字段中包含 request_header 时，该配置必须填写，否则会导致所有字段默认配置修改失败。

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	D7861F61-5B61-46CE-A47C-6B****

示例

正常返回示例

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B****"
}

错误码

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

变更历史

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