All Products
Search

This Product

    Web Application Firewall:DescribeUserApiRequest

    Document Center

    Web Application Firewall:DescribeUserApiRequest

    Last Updated:Jan 12, 2026

    Queries traffic statistics for an API operation.

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

    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-zxu38***
    Domain deprecated

    string

    No

    The domain name or IP address of the API operation.

    Important

    This parameter is deprecated. Use the ApiId parameter instead.

    c.***.com
    ApiFormat deprecated

    string

    No

    The API operation.

    Important

    This parameter is deprecated. Use the ApiId parameter instead.

    /api/v1/know
    Type

    string

    No

    The type of statistics. Valid values:

    • api_ip: total traffic.

    • api_cross_border_ip: cross-border traffic.

    • api_bot_ip: bot traffic.

    • remote_region: geographic location statistics.

    • client_id: client type statistics.

    • http_referer: Referer statistics.

    • api_cnt: total number of calls.

    • bot_cnt: number of bot requests.

    • cross_border_cnt: number of cross-border requests.

    • api_freq: call frequency.

    api_ip
    ClusterId

    string

    No

    The ID of the hybrid cloud cluster.

    Note

    This parameter applies only to hybrid cloud scenarios. Call the DescribeHybridCloudClusters operation to obtain information about hybrid cloud clusters.

    428
    ApiId

    string

    Yes

    The ID of the API.

    3799f0695c0d687f3295d132fe49bc14
    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

    Response elements

    Element

    Type

    Description

    Example

    object

    The request result.

    RequestId

    string

    The request ID.

    D13E4540-4432-5AD7-B216-6369512514F4
    Requests

    array<object>

    The list of statistics.

    object

    The statistics information.

    Value

    string

    The statistics information. This includes:

    • client_list: the client tool.

    • ip: the IP address information.

    • region_id: the region.

    • country_id: the country.

    { "client_list": [ "Unknown" ], "ip": "47.92.113.***", "region_id": "110000", "country_id": "CN" }
    Count

    integer

    The number of statistics.

    76

    Examples

    Success response

    JSON format

    {
  "RequestId": "D13E4540-4432-5AD7-B216-6369512514F4",
  "Requests": [
    {
      "Value": "{\n    \"client_list\": [\n        \"Unknown\"\n    ],\n    \"ip\": \"47.92.113.***\",\n    \"region_id\": \"110000\",\n    \"country_id\": \"CN\"\n}",
      "Count": 76
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.