DescribeSensitiveStatistic - Web Application Firewall - Alibaba Cloud Documentation Center

Queries statistics on sensitive data for data leakage prevention.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to view the ID of your WAF instance.	waf_elasticity-cn-0xldbq****
StartTime	integer	No	The start of the time range to query. The value is a UNIX timestamp in seconds. The time is in UTC.	1672502400
EndTime	integer	No	The end of the time range to query. The value is a UNIX timestamp in seconds. The time is in UTC.	1725966000
StatisticType	string	No	The statistic type. Valid values: ip: statistics by IP address. host: statistics by domain name. sensitive_code: statistics by sensitive data type. api: statistics by API.	ip
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 applies only to hybrid cloud scenarios. Call DescribeHybridCloudClusters to obtain information about hybrid cloud clusters.	428
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response object.
TotalCount	integer	The total number of entries returned.	10
RequestId	string	The request ID.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Data	array<object>	The list of sensitive data statistics.
	object	The sensitive data statistics.
SensitiveCode	string	The sensitive data type. Note Call DescribeApisecRules to obtain the supported sensitive data types.	1003
MatchedHost	string	The domain name.	a.****.com
ApiFormat	string	The API.	/api/login
Count	integer	The number of data entries.	169
ClientIP	string	The IP address.	10.50.11.**

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": [
    {
      "SensitiveCode": "1003",
      "MatchedHost": "a.****.com",
      "ApiFormat": "/api/login",
      "Count": 169,
      "ClientIP": "10.50.11.**"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.