DescribeSensitiveRequestLog - Web Application Firewall - Alibaba Cloud Documentation Center

Queries access logs for 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	The ID of the WAF instance. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf_cdnsdf3****
StartTime	integer	No	The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds.	1723392000
EndTime	integer	No	The end of the time range to query. This value is a UNIX timestamp. Unit: seconds.	1726057800
MatchedHost	string	No	The domain name of the API.	a.***.com
ApiFormat	string	No	The API.	/api/users/login
ClientIP	string	No	The IP address.	103.118.55.**
SensitiveCode	string	No	The type of sensitive data. Note You can call the DescribeApisecRules operation to query the supported sensitive data types.	1000,1001
SensitiveData	string	No	The sensitive data in the response.	user
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter is available only for hybrid cloud scenarios. You can call the DescribeHybridCloudClusters operation to query information about hybrid cloud clusters.	433
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 resource group.	rg-acfm***q
Account	string	No	The account.	admin

Response elements

Element	Type	Description	Example
	object	The result of the request.
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 of the API.	a.****.com
ApiFormat	string	The API.	/api/users/login
TraceId	string	The log ID.	0a3d455b17027784870843933dce3d
RequestTime	integer	The time of the request. This value is a UNIX timestamp. Unit: seconds.	1723392000
Count	integer	The number of outbound sensitive data entries.	12
ClientIP	string	The IP address.	103.118.55.**
ApiId	string	The API ID.	197b52abcd81d6a8bd4***e477
SensitiveList	string	The sensitive data. The value is a string that is converted from a JSON object. In the JSON object, the key indicates the sensitive data type identifier, which can be a built-in or custom type, and the value indicates the list of sensitive data. 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 code of the region to which the IP address belongs.	CN
Account	string	The account that initiated 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.