All Products
Search
Document Center

:DescribeSensitiveRequests

Last Updated:Nov 15, 2024

Queries the tracing results of sensitive data.

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:DescribeSensitiveRequestslist
*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-cn-0xldbqt****
SensitiveCodelongNo

The type of the sensitive data.

Note You can call the DescribeApisecRules operation to query the supported types of sensitive data.
1001
StartTimelongNo

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

1723392000
EndTimelongNo

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

1725966000
SensitiveDatastringNo

The sensitive data.

card
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.
269
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-aekzwwkpn****5i

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountlong

The total number of entries returned.

10
RequestIdstring

The request ID.

26E46541-7AAB-5565-801D-F14DBDC5****
Dataarray<object>

The tracing results of the data.

dataobject

The tracing details.

EventCountlong

The number of events in the previous 30 days.

679
MatchedHoststring

The domain name of the API.

a.****.com
ApiFormatstring

The API.

/api/users/login
DetectionResultstring

The evaluation result. Valid values:

  • leak: Data leaks may occur.
  • none: No data leak can occur.
leak
ClientIPstring

The IP address.

103.118.55.**
ApiIdstring

The ID of the API.

09559c0d71ca2ffc996b81***836d8
SensitiveListarray

The sensitive data.

sensitiveListstring

The sensitive data.

card
InfoCountarray<object>

The statistics of the sensitive data.

infoCountobject

The statistics of the sensitive data.

Countlong

The number of sensitive data entries.

23
Codestring

The type of the sensitive data.

1001
AbnormalCountlong

The number of risks in the previous 30 days.

23

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "RequestId": "26E46541-7AAB-5565-801D-F14DBDC5****",
  "Data": [
    {
      "EventCount": 679,
      "MatchedHost": "a.****.com",
      "ApiFormat": "/api/users/login",
      "DetectionResult": "leak",
      "ClientIP": "103.118.55.**",
      "ApiId": "09559c0d71ca2ffc996b81***836d8",
      "SensitiveList": [
        "card"
      ],
      "InfoCount": [
        {
          "Count": 23,
          "Code": "1001"
        }
      ],
      "AbnormalCount": 23
    }
  ]
}

Error codes

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