All Products
Search
Document Center

Web Application Firewall:ModifyUserLogFieldConfig

Last Updated:Aug 05, 2026

Modifies the default field configuration of the log service for a user.

Operation description

Before calling this operation, make sure that the log service is activated for the WAF instance. Call the DescribeInstance operation to query instance details. If the Details.LogService response parameter is true, the log service is activated. If the log service is not activated, log on to the WAF console and upgrade the instance to activate the log service.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:ModifyUserLogFieldConfig

update

*All Resource

*

  • acs:ResourceGroupId
None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

Instance ID of the WAF instance.

Note

You can call the DescribeInstance operation to query instance ID of the current WAF instance.

waf_v2_public_cn-fou****

FieldList

string

Yes

The list of log fields to deliver. Specify the fields in the "a,b,c,..." format.

Note
  • All required log fields must be included. You can invoke the DescribeCommonLogFields operation to query the log fields supported by Simple Log Service for WAF.

  • If the log fields include request_header, use the delivery extension configuration (ExtendConfig) parameter to specify the request headers to deliver.

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

No

The extended configuration for log delivery. The value is a JSON string constructed from a set of parameters.

Note

For more information, see the Log delivery extended configuration parameter description.

{\"request_header\":\"App-Id,channelCode\"}

DeliveryType

string

No

The delivery type. Valid values:

  • sls: Simple Log Service.

sls

LogDeliveryStrategy

string

No

The log delivery strategy. Multiple strategies are supported. The value is a JSON array string constructed from a set of parameters.

Note

For more information, see the Log delivery strategy parameter description.

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

RegionId

string

No

The region where the WAF instance resides. Valid values:

  • cn-hangzhou: the Chinese mainland.

  • ap-southeast-1: outside the Chinese mainland.

cn-hangzhou

ResourceManagerResourceGroupId

string

No

The ID of the Alibaba Cloud resource group.

rg-acfm***q

Log delivery strategy (LogDeliveryStrategy) parameter description.

Parameter description

NameTypeRequiredExampleDescription
logTypeStringYesblockLogThe log type. Valid values:
- blockLog: block log.
- normalRequestLog: normal request log.
- checkLog: detection log.







rateIntegerYes90The log sampling ratio. Valid values: 1 to 100.

Log delivery extended configuration (ExtendConfig) parameter description.

Parameter description

NameTypeRequiredExampleDescription
request_headerStringYesblockLogThe request headers for log delivery. A maximum of five request headers are supported. Specify the headers in the "a,b,c,..." format.
Important If the log fields to deliver include request_header, this parameter is required. Otherwise, the default configurations modification for all fields fails.

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

E2D63742-9BAA-*****

Examples

Success response

JSON format

{
  "RequestId": "E2D63742-9BAA-*****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.