DescribeApisecSensitiveDomainStatistic - Web Application Firewall

Queries statistics on domain names where sensitive data is detected by the API security module.

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 support 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:DescribeApisecSensitiveDomainStatistic

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note Call the DescribeInstance operation to query the ID of the current WAF instance.	waf_cdnsdf3****
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter is applicable only to hybrid cloud scenarios. Call the DescribeHybridCloudClusters operation to obtain information about hybrid cloud clusters.	428
StartTime	integer	No	The beginning of the time range to query. Specify a Unix timestamp in UTC. Unit: milliseconds.	1668496310
EndTime	integer	No	The end of the time range to query. Specify a Unix timestamp in UTC. Unit: milliseconds.	1686895256
PageNumber	integer	No	The page number. Default value: 1, which indicates the first page.	1
PageSize	integer	No	The number of entries per page. Default value: 5, which indicates 5 entries per page.	5
Type	string	No	The type of sensitive data. Valid values: request: Sensitive data in requests. response: Sensitive data in responses.	request
OrderWay	string	No	The sorting method of the list. Valid values: asc: Ascending order. desc: Descending order.	desc
RegionId	string	No	The region of the WAF instance. 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

Response parameters

Parameter	Type	Description	Example
	object	The result of the request.
TotalCount	integer	The total number of entries returned.	27
RequestId	string	The request ID.	56B40D30-4960-4F19-B7D5-2B1F***6CB70
Data	array	The response parameters.
	object	The response parameters.
SensitiveLevel	string	The sensitivity level of the API. Valid values: S1: Low sensitivity. S2: Medium sensitivity. S3: High sensitivity.	L3
ApiCount	integer	The number of APIs involved.	10
SensitiveCode	string	The code of the sensitive data. Note Call the DescribeApisecRules operation to query the supported types of sensitive data.	10
SensitiveName	string	The data name of the sensitive data.	1002
DomainCount	integer	The number of sites involved.	10

Examples

Success response

JSON format

{
  "TotalCount": 27,
  "RequestId": "56B40D30-4960-4F19-B7D5-2B1F***6CB70",
  "Data": [
    {
      "SensitiveLevel": "L3",
      "ApiCount": 10,
      "SensitiveCode": "10",
      "SensitiveName": "1002",
      "DomainCount": 10
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.