All Products
Search

This Product

    Web Application Firewall:DescribeUserLogFieldConfig

    Document Center

    Web Application Firewall:DescribeUserLogFieldConfig

    Last Updated:Mar 11, 2026

    Queries the log field configuration of a Web Application Firewall (WAF) instance, including additional fields, removed fields, delivery strategies, and extended settings.

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

    get

    *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 query the ID of the WAF instance.

    waf_v3prepaid_public_cn-0*****
    DeliveryType

    string

    No

    The log delivery type. Valid values:

    • sls: Simple Log Service.

    sls
    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 resource group.

    rg-aek24******

    Response elements

    Element

    Type

    Description

    Example

    object

    AddList

    string

    The additional log fields that are added to the default configuration. Multiple fields are separated by commas (,) in the a,b,c,... format.

    acl_action,acl_rule_id
    RequestId

    string

    The ID of the request.

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

    string

    The log delivery policies. Multiple policies are supported. The value is a JSON-formatted string that contains an array of policy objects.

    Note

    For more information, see the LogDeliveryStrategy parameter description in ModifyUserLogFieldConfig.

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

    string

    The extended configuration for log delivery. The value is a JSON-formatted string that contains configuration key-value pairs, such as custom request headers.

    Note

    For more information, see the ExtendConfig parameter description in ModifyUserLogFieldConfig.

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

    string

    The status of the log field configuration. Valid values:

    • initial: The log field configuration is being initialized.

    • updating: The log field configuration is being updated.

    • failed_finished: The log field configuration update failed.

    • success_finished: The log field configuration update succeeded.

    success_finished
    DelList

    string

    The default log fields that are excluded from the log delivery configuration. Multiple fields are separated by commas (,) in the a,b,c,... format.

    waf_rule_id,waf_rule_type
    FieldList

    string

    The complete list of log fields that are delivered. Multiple fields are separated by commas (,) in the a,b,c,... format.

    account,acl_action,acl_rule_id,acl_rule_type
    DeliveryType

    string

    The log delivery type. Valid values:

    • sls: Simple Log Service.

    sls

    Examples

    Success response

    JSON format

    {
  "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"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.