Sensitive API Statistics for Personal Data Protection Overview - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries statistics on sites and API operations that involve personal information.

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

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 DescribeInstance to query the ID of the current WAF instance.	waf_cdnsdf3****
MatchedHost	string	No	The domain name or IP address to which the API operation belongs.	a.***.com
StartTime	integer	No	The beginning of the time range to query. The value is a UNIX timestamp (UTC) in seconds. Note Compliance review currently supports querying data only for the last 1 month, last 3 months, last 6 months, last 12 months, or from January 1 of the previous year to the present. Make sure the time range is valid.	1672502400
EndTime	integer	No	The end of the time range to query. The value is a UNIX timestamp (UTC) in seconds. Note Compliance review currently supports querying data only for the last 1 month, last 3 months, last 6 months, last 12 months, or from January 1 of the previous year to the present. Make sure the time range is valid.	1725966000
PageNumber	integer	No	The page number to return in a paged query. Default value: 1, which indicates the first page.	1
PageSize	integer	No	The number of entries per page in a paged query. Default value: 10, which indicates 10 entries per page.	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 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
Type	string	No	The dimension for statistics. Valid values: matchedHost (default): statistics by domain name. apiFormat: statistics by API operation. Note When the apiFormat dimension is used, specify the corresponding domain name in the MatchedHost parameter.	matchedHost

Response elements

Element	Type	Description	Example
	object	The request result.
TotalCount	integer	The total number of entries returned.	10
RequestId	string	The request ID.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Data	array<object>	The statistics list.
	array<object>	The statistics information.
SensitiveOutboundCount	integer	The number of outbound sensitive personal information items at the domain name level.	127
MatchedHost	string	The domain name or IP address.	www.***.top
List	array<object>	The list of API operation statistics information under the domain name. Note This field is returned only when the Type parameter is set to apiFormat, which represents the API dimension statistics information.
	object	The API operation statistics information under the domain name.
SensitiveCode	array	The list of sensitive data types.
	string	The sensitive data type.	1003
ApiFormat	string	The API.	/api/login
SensitiveCount	integer	The number of outbound personal sensitive data entries by API.	55
ApiId	string	The ID of the API.	d288137009c119a873d4c395****
InfoCount	integer	The number of outbound personal information entries by API.	78
InfoOutboundCount	integer	The number of outbound personal information entries at the domain name level.	213

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": [
    {
      "SensitiveOutboundCount": 127,
      "MatchedHost": "www.***.top",
      "List": [
        {
          "SensitiveCode": [
            "1003"
          ],
          "ApiFormat": "/api/login",
          "SensitiveCount": 55,
          "ApiId": "d288137009c119a873d4c395****",
          "InfoCount": 78
        }
      ],
      "InfoOutboundCount": 213
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.