DescribeUserLogFieldConfig - 查询用户默认日志字段配置

查询用户默认日志字段配置。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeUserLogFieldConfig

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

WAF 实例的 ID。

说明

您可以调用 DescribeInstance ,查看当前 WAF 实例的 ID。

waf_v3prepaid_public_cn-0*****

DeliveryType

string

投递类型。取值:

  • sls: 阿里云日志服务。

sls

RegionId

string

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

ResourceManagerResourceGroupId

string

阿里云资源组 ID。

rg-aek24******

返回参数

名称

类型

描述

示例值

object

AddList

string

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

acl_action,acl_rule_id

RequestId

string

本次请求的 ID。

653778B4-4D47-5223-855B-4E******

LogDeliveryStrategy

string

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

说明

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

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

ExtendConfig

string

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

说明

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

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

ConfigStatus

string

日志字段配置状态。取值:

  • initial:表示配置处于初始化状态。

  • updating:表示配置更新中。

  • failed_finished:表示配置失败。

  • success_finished:表示配置成功。

success_finished

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

DeliveryType

string

投递类型。取值:

  • sls: 阿里云日志服务。

sls

示例

正常返回示例

JSON格式

{
  "AddList": "acl_action,acl_rule_id",
  "RequestId": "653778B4-4D47-5223-855B-4E******",
  "LogDeliveryStrategy": "[{\\\"logType\\\":\\\"blockLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"normalRequestLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"checkLog\\\",\\\"rate\\\":100}]",
  "ExtendConfig": "{\\\"request_header\\\":\\\"Ali-Cdn-Real-Ip\\\"}",
  "ConfigStatus": "success_finished",
  "DelList": "waf_rule_id,waf_rule_type",
  "FieldList": "account,acl_action,acl_rule_id,acl_rule_type",
  "DeliveryType": "sls"
}

错误码

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

变更历史

更多信息,参考变更详情