DescribeSensitiveRequests API: Query WAF Sensitive Request Logs - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries the results of sensitive data tracing.

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

list

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to query the ID of the current WAF instance.	waf-cn-0xldbqt****
SensitiveCode	integer	No	The type of sensitive data. Note You can call DescribeApisecRules to obtain the supported sensitive data types.	1001
StartTime	integer	No	The beginning of the time range to query. The value is a UNIX timestamp (UTC). Unit: seconds.	1723392000
EndTime	integer	No	The end of the time range to query. The value is a UNIX timestamp (UTC). Unit: seconds.	1725966000
SensitiveData	string	No	The sensitive data.	card
PageNumber	integer	No	The page number when you use paged query. Default value: 1, which indicates that the first page is returned in the paging result.	1
PageSize	integer	No	The number of entries per page when you use paged query. Default value: 10, which indicates that each page contains 10 entries in the paging result.	10
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter applies only to hybrid cloud scenarios. You can call DescribeHybridCloudClusters to obtain hybrid cloud cluster information.	269
RegionId	string	No	The region in which the WAF instance is deployed. 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-aekzwwkpn****5i

Response elements

Element	Type	Description	Example
	object	The response.
TotalCount	integer	The total number of entries returned.	10
RequestId	string	The request ID.	26E46541-7AAB-5565-801D-F14DBDC5****
Data	array<object>	The list of data tracing results.
	array<object>	The data tracing information.
EventCount	integer	The number of events in the last 30 days.	679
MatchedHost	string	The domain name to which the API operation belongs.	a.****.com
ApiFormat	string	The API operation.	/api/users/login
DetectionResult	string	The assessment result. Valid values: leak: a leak risk exists. none: no leak risk exists.	leak
ClientIP	string	The IP address.	103.118.55.**
ApiId	string	The ID of the API.	09559c0d71ca2ffc996b81***836d8
SensitiveList	array	The list of sensitive data.
	string	The sensitive data.	card
InfoCount	array<object>	The list of sensitive data statistics.
	object	The sensitive data statistics information.
Count	integer	The number of sensitive data entries.	23
Code	string	The type of sensitive data.	1001
AbnormalCount	integer	The number of risks in the last 30 days.	23

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "26E46541-7AAB-5565-801D-F14DBDC5****",
  "Data": [
    {
      "EventCount": 679,
      "MatchedHost": "a.****.com",
      "ApiFormat": "/api/users/login",
      "DetectionResult": "leak",
      "ClientIP": "103.118.55.**",
      "ApiId": "09559c0d71ca2ffc996b81***836d8",
      "SensitiveList": [
        "card"
      ],
      "InfoCount": [
        {
          "Count": 23,
          "Code": "1001"
        }
      ],
      "AbnormalCount": 23
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.