DescribeResourceLogFieldConfig - 查询防护对象的日志字段配置

查询防护对象的日志字段配置。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

WAF 实例 ID。

说明

您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。

waf_v3prepaid_public_cn-zpr3*******

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

要查询的防护对象。

test.waf.com-waf

返回参数

名称

类型

描述

示例值

object

AddList

string

除默认日志字段外,额外配置的日志字段列表,使用"a,b,c,……"格式表示。

acl_test,acl_action,acl_rule_id,waf_test,acl_rule_type

RequestId

string

请求 ID。

7B53B47C-D368-5344-BB5E-79******

LogDeliveryStrategy

string

日志投递策略,支持多个策略。以一系列参数构造的 JSON 数组格式转化成字符串。

说明

详细参数信息,请参见 ModifyResourceLogFieldConfig 接口的日志投递策略LogDeliveryStrategy)参数描述。

[{\"logType\":\"blockLog\",\"rate\":100},{\"logType\":\"normalRequestLog\",\"rate\":100},{\"logType\":\"checkLog\",\"rate\":100}]

ExtendConfig

string

日志投递扩展配置。以一系列参数构造的 JSON 格式转化成字符串。

说明

详细参数信息,请参见 ModifyResourceLogFieldConfig 接口的日志投递扩展配置ExtendConfig)参数描述。

{\"request_header\":\"Ali-Cdn-Real-Ip\"}

DelList

string

相对于默认日志字段,少配置的日志字段列表,使用"a,b,c,……"格式表示。

waf_rule_id,waf_rule_type

FieldList

string

投递的日志字段列表,使用"a,b,c,……"格式表示。

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

DeliveryType

string

日志投递类型。取值:

  • sls: 表示阿里云日志服务。

  • kafka:表示外发投递到 kafka 日志。

  • syslog:表示外发投递到 syslog 日志。

sls

示例

正常返回示例

JSON格式

{
  "AddList": "acl_test,acl_action,acl_rule_id,waf_test,acl_rule_type",
  "RequestId": "7B53B47C-D368-5344-BB5E-79******",
  "LogDeliveryStrategy": "[{\\\"logType\\\":\\\"blockLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"normalRequestLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"checkLog\\\",\\\"rate\\\":100}]",
  "ExtendConfig": "{\\\"request_header\\\":\\\"Ali-Cdn-Real-Ip\\\"}",
  "DelList": "waf_rule_id,waf_rule_type",
  "FieldList": "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",
  "DeliveryType": "sls"
}

错误码

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

变更历史

更多信息,参考变更详情