All Products
Search

This Product

    Web Application Firewall:ModifyResourceLogFieldConfig

    Document Center

    Web Application Firewall:ModifyResourceLogFieldConfig

    Last Updated:Nov 27, 2025

    Modifies the log field configuration of a protected object.

    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:ModifyResourceLogFieldConfig

    update

    *All Resource

    *
    • acs:ResourceGroupId
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the WAF instance.

    Note

    Call DescribeInstance to query the ID of the current WAF instance.

    waf_v3prepaid_public_cn-uax****3k0e
    FieldList

    string

    Yes

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

    Note

    • Include all required log fields. Call DescribeCommonLogFields to view the log fields that WAF Simple Log Service 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 extension configuration for log delivery. This is a JSON object converted to a string.

    Note

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

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

    string

    Yes

    The log delivery type. Valid values:

    • sls: Alibaba Cloud Simple Log Service.

    • kafka: Delivers logs to an external Kafka cluster.

    • syslog: Delivers logs to an external syslog server.

    sls
    ResourceManagerResourceGroupId

    string

    No

    The ID of the Alibaba Cloud resource group.

    rg-acfm***q
    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
    Resource

    string

    Yes

    The protected object to modify.

    cwaf-***-waf
    LogDeliveryStrategy

    string

    No

    The log delivery policies. Multiple policies are supported. This is a JSON array of policy objects converted to a string.

    Note

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

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

    The LogDeliveryStrategy parameter

    Parameters

    NameTypeRequiredExampleDescription
    logTypeStringYesblockLogThe log type. Valid values:
    - blockLog: Blocked request logs.
    - normalRequestLog: Normal request logs.
    - checkLog: Detection logs.







    rateIntegerYes90The log sampling ratio. The value must be between 1 and 100.

    The ExtendConfig parameter

    Parameters

    NameTypeRequiredExampleDescription
    request_headerStringYesblockLogThe request headers for log delivery. You can specify up to five headers. Use the `a,b,c,...` format.
    Important If the log fields to deliver include `request_header`, this parameter is required. Otherwise, the modification of the default configurations for all fields fails.

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    D7861F61-5B61-46CE-A47C-6B****

    Examples

    Success response

    JSON format

    {
  "RequestId": "D7861F61-5B61-46CE-A47C-6B****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.