DescribeDcdnWafUsageData - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries usage data for Web Application Firewall (WAF).

Operation description

Note

The call frequency for a single user is limited to 10 calls per second.
The minimum time granularity is 5 minutes. The maximum time span for a single query is 31 days. You can query data from the last 90 days.

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

dcdn:DescribeDcdnWafUsageData

get

*Domain

acs:dcdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. If you do not specify this parameter, data for all accelerated domain names is returned.	example.com
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2018-09-30T16:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The end time must be later than the start time.	2018-10-01T16:00:00Z
Interval	string	No	The time granularity of the data, in seconds. The value depends on the time span of the query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day).	300
SplitBy	string	No	The method used to group data. Valid values: domain: groups data by accelerated domain name. If you do not specify this parameter, the data is not grouped.	domain

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range.	2018-10-01T16:00:00Z
StartTime	string	The start of the time range.	2018-09-30T16:00:00Z
RequestId	string	The request ID.	CB1A380B-09F0-41BB-802B-72F8FD6DA2FE
WafUsageData	object
WafUsageDataItem	array<object>	The WAF usage data for the accelerated domain names.
	object
ObserveCnt	integer	The number of requests that were monitored.	300
Domain	string	The accelerated domain name.	example.com
BlockCnt	integer	The number of requests that were blocked.	300
AccessCnt	integer	The number of normal requests.	600
TimeStamp	string	The start of the time slice.	2018-09-30T16:00:00Z
SecCu	integer	The number of security compute units (SeCUs) generated.	50

Examples

Success response

JSON format

{
  "EndTime": "2018-10-01T16:00:00Z",
  "StartTime": "2018-09-30T16:00:00Z",
  "RequestId": "CB1A380B-09F0-41BB-802B-72F8FD6DA2FE",
  "WafUsageData": {
    "WafUsageDataItem": [
      {
        "ObserveCnt": 300,
        "Domain": "example.com",
        "BlockCnt": 300,
        "AccessCnt": 600,
        "TimeStamp": "2018-09-30T16:00:00Z",
        "SecCu": 50
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	The format of the specified start time or end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Configure a valid time span as described in API documentation.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.