DescribeSensitiveOutboundStatistic - Web Application Firewall

Queries statistics about outbound transfers of 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:DescribeSensitiveOutboundStatistic

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the current WAF instance.	waf-cn-0xldbqt****
StartTime	integer	No	The beginning of the time range to query. This value is a UNIX timestamp that is in UTC. Unit: seconds. Note Compliance assessment supports querying data from the last month, the last 3 months, the last 6 months, the last 12 months, and from January 1 of the previous year to the present. Make sure that the time range is valid.	1672502400
EndTime	integer	No	The end of the time range to query. This value is a UNIX timestamp that is in UTC. Unit: seconds. Note Compliance assessment supports querying data from the last month, the last 3 months, the last 6 months, the last 12 months, and from January 1 of the previous year to the present. Make sure that the time range is valid.	1725966000
SensitiveType	string	No	The type of information to query. Valid values: info: all personal information. This is the default value. sensitive: only sensitive personal information.	info
SensitiveLevel	string	No	The sensitivity level. Valid values: high: high. medium: medium. low: low.	high
SensitiveCode	string	No	The type of sensitive data. Separate multiple types with commas (,). Note Call DescribeApisecRules to obtain the supported sensitive data types. This parameter supports only built-in sensitive data types.	1000,1001
DetectionResult	string	No	The assessment result. Valid values: report: A data outbound transfer threat exists. none: No data outbound transfer threat exists.	report
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
OrderKey	string	No	The field to use for sorting. Valid values: total_count: The total number of data entries. This is the default value. outbound_count: The total number of outbound data entries.	total_count
OrderWay	string	No	The sorting order. Valid values: desc: Descending order. This is the default value. asc: Ascending order.	desc
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter is available only for hybrid cloud scenarios. Call DescribeHybridCloudClusters to query information about hybrid cloud clusters.	428
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

Response elements

Element	Type	Description	Example
	object	The request result.
TotalCount	integer	The total number of returned entries.	5
RequestId	string	The request ID.	2EFCFE18-78F8-5079-B312-07***48B
Data	array<object>	The list of statistics on outbound transfers of personal information.
	object	The statistics on an outbound transfer of personal information.
SensitiveLevel	string	The sensitivity level. Valid values: high: high. medium: medium. low: low.	high
SensitiveCode	integer	The type of sensitive data. Note Call DescribeApisecRules to obtain the supported sensitive data types.	1001
OutboundCount	integer	The number of outbound data entries.	300
DetectionResult	string	The assessment result. Valid values: report: A data outbound transfer threat exists. none: No data outbound transfer threat exists.	report
SensitiveType	string	The type of information to query. Valid values: info: all personal information. sensitive: only sensitive personal information.	info
InfoCount	integer	The total number of data entries.	546

Examples

Success response

JSON format

{
  "TotalCount": 5,
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "Data": [
    {
      "SensitiveLevel": "high",
      "SensitiveCode": 1001,
      "OutboundCount": 300,
      "DetectionResult": "report",
      "SensitiveType": "info",
      "InfoCount": 546
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.