DescribeFlowChart - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the traffic statistics.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTimestamp	string	Yes	The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds.	1665331200
EndTimestamp	string	No	The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. If you do not set this parameter, the current time is used as the end time.	1665386280
Interval	string	Yes	The time interval. Unit: seconds. The value must be a multiple of 60.	300
Resource	string	No	The protected object that you want to query.	www.aliyundoc.com
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to query the ID of your WAF instance.	waf_cdnsdf3****
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 resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	BFA71416-670E-585D-AAE6-E7BBEE248FAB
FlowChart	array<object>	The traffic statistics.
	object	The traffic statistics.
MaxPv	integer	The peak number of requests.	2932
AntibotBlockSum	integer	The number of requests that are blocked by bot management rules.	0
CcCustomReportsSum	integer	The number of requests that are monitored by custom CC protection rules.	0
RatelimitBlockSum	integer	The number of requests that are blocked by peak traffic throttling rules.	0
BlacklistBlockSum	string	The number of requests that are blocked by the IP address blacklist.	0
CcSystemBlocksSum	integer	The number of requests that are blocked by system CC protection rules.	0
BlacklistReportsSum	integer	The number of requests that are monitored by the IP address blacklist.	0
Index	integer	The time sequence number, sorted in chronological order.	10
RobotCount	integer	The total number of requests from bots.	1110
Count	integer	The total number of requests.	2932
RegionBlockReportsSum	integer	The number of requests that are monitored by Location Blacklist rules.	0
AntiScanBlockSum	integer	The number of requests that are blocked by scan protection rules.	0
CcSystemReportsSum	integer	The number of requests that are monitored by system CC protection rules.	0
AntibotReportSum	string	The number of requests that are monitored by bot management rules.	0
InBytes	integer	The total volume of inbound traffic, in bytes.	121645464
WafBlockSum	integer	The number of requests that are blocked by basic protection rules.	0
CcCustomBlockSum	integer	The number of requests that are blocked by custom CC protection rules.	0
AntiscanReportsSum	integer	The number of requests that are monitored by scan protection rules.	0
AclCustomBlockSum	integer	The number of requests that are blocked by custom access control list (ACL) rules.	0
RatelimitReportSum	integer	The number of requests that are monitored by peak traffic throttling rules.	0
WafReportSum	string	The number of requests that are monitored by basic protection rules.	0
AclCustomReportsSum	integer	The number of requests that are monitored by custom ACL rules.	0
OutBytes	integer	The total volume of outbound traffic, in bytes.	1200540464
RegionBlockBlocksSum	integer	The number of requests that are blocked by Location Blacklist rules.	0

Examples

Success response

JSON format

{
  "RequestId": "BFA71416-670E-585D-AAE6-E7BBEE248FAB",
  "FlowChart": [
    {
      "MaxPv": 2932,
      "AntibotBlockSum": 0,
      "CcCustomReportsSum": 0,
      "RatelimitBlockSum": 0,
      "BlacklistBlockSum": "0",
      "CcSystemBlocksSum": 0,
      "BlacklistReportsSum": 0,
      "Index": 10,
      "RobotCount": 1110,
      "Count": 2932,
      "RegionBlockReportsSum": 0,
      "AntiScanBlockSum": 0,
      "CcSystemReportsSum": 0,
      "AntibotReportSum": "0",
      "InBytes": 121645464,
      "WafBlockSum": 0,
      "CcCustomBlockSum": 0,
      "AntiscanReportsSum": 0,
      "AclCustomBlockSum": 0,
      "RatelimitReportSum": 0,
      "WafReportSum": "0",
      "AclCustomReportsSum": 0,
      "OutBytes": 1200540464,
      "RegionBlockBlocksSum": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.