Use DescribeSensitiveDetectionResult to Audit WAF API Compliance - Web Application Firewall

Queries the compliance detection results for API security.

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

get

*All Resource

*

acs:ResourceGroupId

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 WAF instance.	waf-cn-7pp26f1****
StartTime	integer	No	The start time of the query. The value is a UNIX timestamp in seconds.	1672502400
EndTime	integer	No	The end time of the query. The value is a UNIX timestamp in seconds.	1725966000
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter is available only for hybrid cloud scenarios. Call the DescribeHybridCloudClusters operation to obtain the hybrid cloud cluster information.	428
RegionId	string	No	The region in which the WAF instance resides. Valid values: cn-hangzhou: 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 elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Data	object	The data returned for the compliance detection results.
Result	array<object>	The compliance detection results for sensitive data.
	array<object>	The details of a compliance detection result.
Max	object	The statistics for the most frequently detected sensitive data type.
SensitiveCode	integer	The code of the sensitive data type that is most frequently detected.	1003
OutboundCount	integer	The number of outbound transfers of personal information for the most frequently detected sensitive data type.	54
InfoCount	integer	The number of personal information items for the most frequently detected sensitive data type.	187
DetectionResult	string	The result of the compliance detection. Valid values: report: A risk of outbound data transfer is detected. none: No risk of outbound data transfer is detected.	report
List	array<object>	The detection results for each sensitive data type.
	object	The detection details for a sensitive data type.
SensitiveCode	integer	The code of the sensitive data type.	1002
OutboundCount	integer	The number of outbound transfers of personal information.	6
InfoCount	integer	The number of personal information items.	11

Examples

Success response

JSON format

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": {
    "Result": [
      {
        "Max": {
          "SensitiveCode": 1003,
          "OutboundCount": 54,
          "InfoCount": 187
        },
        "DetectionResult": "report",
        "List": [
          {
            "SensitiveCode": 1002,
            "OutboundCount": 6,
            "InfoCount": 11
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.