All Products
Search

This Product

    Web Application Firewall:ModifyUserLogFieldConfig

    Document Center

    Web Application Firewall:ModifyUserLogFieldConfig

    Last Updated:Mar 11, 2026

    Modifies the default log field configuration of a Web Application Firewall (WAF) instance for log delivery to Simple 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

    The ID of the WAF instance.

    Note

    Call the DescribeInstance operation to view the ID of your WAF instance.

    waf_v2_public_cn-fou****
    FieldList

    string

    Yes

    The list of log fields to deliver. Use the `a,b,c,...` format.

    Note

    • You must include all required log fields. Call the DescribeCommonLogFields operation to view the log fields that WAF supports.

    • If the log fields include request_header, use the 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, in JSON format.

    Note

    For more information, see the description of the ExtendConfig parameter.

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

    string

    No

    The delivery type. Valid value:

    • sls: Simple Log Service.

    sls
    LogDeliveryStrategy

    string

    No

    The log delivery strategy, in JSON array format. You can specify multiple strategies.

    Note

    For more information, see the description of the LogDeliveryStrategy parameter.

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

    string

    No

    The region in which 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

    LogDeliveryStrategy parameter

    Parameters

    Name Type Required Example Description
    logType String Yes blockLog The log type. Valid values:
    - blockLog: blocked logs.
    - normalRequestLog: normal request logs.
    - checkLog: detection logs.
    rate Integer Yes 90 The log sampling ratio, in percentage. Valid values: 1 to 100.

    ExtendConfig parameter

    Parameters

    Name Type Required Example Description
    request_header String Yes App-Id,channelCode The request headers for log delivery. You can specify up to 5 headers. Use the `a,b,c,...` format.
    Important If the log fields to deliver include `request_header`, you must specify this parameter. Otherwise, the modification of the default configurations for all fields fails.

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    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.