DescribeCommonLogFields - 查询日志服务支持的所有日志字段

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeCommonLogFields

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。	waf_v3prepaid_public_cn-l*****
IsRequired	boolean	否	日志字段是否为必选字段。 true：表示必选日志字段。 false：表示非必选日志字段。	false
IsDefault	boolean	否	日志字段是否为默认字段。 true：表示查询默认日志字段。 false：表示查询非默认日志字段。	true
LogKeyList	array	否	要查询的日志字段列表。
	string	否	要查询的日志字段。	final_action
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-aek2sxgs*****

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	日志字段总数。	6
RequestId	string	当前请求的 ID。	AB0775EB-2594-598A-97E1-51B1*******
LogFieldList	array<object>	日志字段列表。
	object	日志字段详情。
Status	boolean	日志字段状态列表。取值： 0：表示下线状态。 1：表示上线状态或使用中。 2：表示即将下线。 3：表示即将上线。	1
IsDefault	boolean	日志字段是否为默认字段。 true：表示默认日志字段。 false：表示非默认日志字段。	true
IsRequired	boolean	日志字段是否为必选字段。 true：表示必选日志字段。 false：表示非必选日志字段。	true
LogKey	string	日志字段。说明具体的日志字段含义，可以查阅WAF 官方文档（日志字段说明）。	final_action

示例

正常返回示例

JSON格式

{
  "TotalCount": 6,
  "RequestId": "AB0775EB-2594-598A-97E1-51B1*******",
  "LogFieldList": [
    {
      "Status": true,
      "IsDefault": true,
      "IsRequired": true,
      "LogKey": "final_action"
    }
  ]
}

错误码

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

变更历史

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