All Products
Search
Document Center

:DescribeSensitiveStatistic

Last Updated:Nov 15, 2024

Queries the sensitive data statistics of the tracing and auditing feature.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:DescribeSensitiveStatisticget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the WAF instance.

Note You can call the DescribeInstance operation to query the ID of the WAF instance.
waf_elasticity-cn-0xldbq****
StartTimelongNo

The beginning of the time range to query. The value is a UNIX timestamp displayed in UTC. Unit: seconds.

1672502400
EndTimelongNo

The end of the time range to query. The value is a UNIX timestamp displayed in UTC. Unit: seconds.

1725966000
StatisticTypestringNo

The type of the statistics. Valid values:

  • ip: IP address
  • host: domain name
  • sensitive_code: sensitive data type
  • api: sensitive data-related API
ip
PageNumberlongNo

The page number. Default value: 1.

1
PageSizelongNo

The number of entries per page. Default value: 10.

10
ClusterIdintegerNo

The ID of the hybrid cloud cluster.

Note For hybrid cloud scenarios only, you can call the DescribeHybridCloudClusters operation to query the hybrid cloud clusters.
428
RegionIdstringNo

The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland
  • ap-southeast-1: outside the Chinese mainland
cn-hangzhou
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountlong

The total number of entries returned.

10
RequestIdstring

The request ID.

D7861F61-5B61-46CE-A47C-6B19160D5EB0
Dataarray<object>

The statistics of the sensitive data.

dataobject

The statistics of the sensitive data.

SensitiveCodestring

The type of the sensitive data.

Note You can call the DescribeApisecRules operation to query the supported types of sensitive data.
1003
MatchedHoststring

The domain name.

a.****.com
ApiFormatstring

The API.

/api/login
Countlong

The number of entries returned.

169
ClientIPstring

The IP address.

10.50.11.**

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.