Audit Sensitive Request Logs with DescribeSensitiveRequestLog - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries the access log information of sensitive data.

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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID of the WAF instance. Note You can call the DescribeInstance operation to query instance ID of the current WAF instance.	waf_cdnsdf3****
StartTime	integer	No	The start time of the query, in UNIX timestamp (UTC) format. Unit: seconds.	1723392000
EndTime	integer	No	The end time of the query, in UNIX timestamp (UTC) format. Unit: seconds.	1726057800
MatchedHost	string	No	The domain name to which the API operation belongs.	a.***.com
ApiFormat	string	No	The API operation.	/api/users/login
ClientIP	string	No	The IP address.	103.118.55.**
SensitiveCode	string	No	The sensitive data type. Note You can call the DescribeApisecRules operation to query the supported sensitive data types.	1000,1001
SensitiveData	string	No	The response sensitive data.	user
PageNumber	integer	No	The page number of the page to return in a paged query. Default value: 1, which indicates the first page. Paging starts from page 1.	1
PageSize	integer	No	The number of entries to return on each page in a paged query. Default value: 10, which indicates 10 entries per page. Paging starts from page 1.	10
ClusterId	string	No	The hybrid cloud cluster ID. Note This parameter applies only to hybrid cloud scenarios. You can call the DescribeHybridCloudClusters operation to query hybrid cloud cluster information.	433
RegionId	string	No	The region where 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 Alibaba Cloud resource group ID.	rg-acfm***q
Account	string	No	The account information.	admin

Response elements

Element	Type	Description	Example
	object	The response.
TotalCount	integer	The total number of entries returned.	7
RequestId	string	The request ID.	26E46541-7AAB-5565-801D-F14DBDC5****
Data	array<object>	The list of access logs.
	object	The access log information.
MatchedHost	string	The domain name to which the API operation belongs.	a.****.com
ApiFormat	string	The API operation.	/api/users/login
TraceId	string	The log ID.	0a3d455b17027784870843933dce3d
RequestTime	integer	The request time, in UNIX timestamp (UTC) format. Unit: seconds.	1723392000
Count	integer	The number of outbound sensitive data entries.	12
ClientIP	string	The IP address.	103.118.55.**
ApiId	string	The ID of the API.	197b52abcd81d6a8bd4***e477
SensitiveList	string	The sensitive data information. The value is a JSON string constructed from a series of parameters. The key of the JSON object is the sensitive data type identifier, which can be built-in or custom. The value is a list of sensitive data entries. Note You can call the DescribeApisecRules operation to query the supported sensitive data types.	{ "1000":[ "90.88.49.19", "90.88.49.19" ], "835436":[ "www.abc.com" ] }
RemoteCountryId	string	The region to which the IP address belongs, in region identifier code format.	CN
Account	string	The account of the request.	admin

Examples

Success response

JSON format

{
  "TotalCount": 7,
  "RequestId": "26E46541-7AAB-5565-801D-F14DBDC5****",
  "Data": [
    {
      "MatchedHost": "a.****.com",
      "ApiFormat": "/api/users/login",
      "TraceId": "0a3d455b17027784870843933dce3d",
      "RequestTime": 1723392000,
      "Count": 12,
      "ClientIP": "103.118.55.**",
      "ApiId": "197b52abcd81d6a8bd4***e477",
      "SensitiveList": "{\n          \"1000\":[ \n              \"90.88.49.19\",\n              \"90.88.49.19\"\n          ],\n          \"835436\":[ \n              \"www.abc.com\"\n          ]\n}",
      "RemoteCountryId": "CN",
      "Account": "admin"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.