Operation description

Each account can call this operation up to 10 times per second.
The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table.

Time granularity	Maximum time range per query	Historical data available	Data delay
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours
1 day	90 days	366 days	04:00 on the next day

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

cdn:DescribeDomainUsageData

none

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. You can specify up to 100 domain names in each request. Separate multiple domain names with commas (,). Note If you leave this parameter empty, the usage data of all accelerated domain names in your Alibaba Cloud account is returned.	example.com
StartTime	string	Yes	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. Note Data is collected every 5 minutes.	2015-12-10T20:00:00Z
EndTime	string	Yes	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. The maximum time range that can be specified is 31 days.	2015-12-10T22:00:00Z
Field	string	Yes	The type of the data that you want to query. Valid values: bps: bandwidth traf: traffic acc: requests Note If you set this parameter to acc, the Area parameter is not supported.	bps
Type	string	No	The type of content that you want to query. Valid values: static: static content dynamic: dynamic content all (default): both static and dynamic content	static
DataProtocol	string	No	The protocol of the data that you want to query. Valid values: http: HTTP https: HTTPS quic: QUIC all (default): HTTP, HTTPS, and QUIC	all
Area	string	No	The billable region. Valid values: CN (default): inside the Chinese mainland OverSeas: outside the Chinese mainland AP1: Asia Pacific 1 AP2: Asia Pacific 2 AP3: Asia Pacific 3 NA: North America SA: South America EU: Europe MEAA: Middle East and Africa all: all the preceding billable regions	CN
Interval	string	No	The time granularity of the data entries. Unit: seconds. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). If Interval is set to 300, you can query usage data in the last 6 months. The maximum time range per query that can be specified is 3 days. If Interval is set to 3600 or 86400, you can query usage data of the previous year. If you leave the Interval parameter empty, the maximum time range that you can query is 1 month. If you specify a time range of 1 to 3 days, the time interval between the entries that are returned is 1 hour. If you specify a time range of at least 4 days, the time interval between the entries that are returned is 1 day.	300

Billable items and parameters

The following table describes the parameters of each billable item. For more information about how to call relevant operations, see the sample requests.

Billable item	Valid value of DataProtocol	Valid value of Type	Valid value of Field	Valid value of Area
Data transfer	all or no value	all or no value	traf	CN, OverSeas, AP1, AP2, AP3, NA, SA, EU, and MEAA
Bandwidth	all or no value	all or no value	bps	CN, OverSeas, AP1, AP2, AP3, NA, SA, EU, and MEAA
HTTPS requests for static content	https	static	acc	all
HTTP requests for dynamic content	http	dynamic	acc	all
HTTPS requests for dynamic content	https	dynamic	acc	all
QUIC requests for dynamic content	quic	dynamic	acc	all
QUIC requests for static content	quic	static	acc	all

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	The accelerated domain name.	example.com
StartTime	string	The beginning of the time range during which data was queried.	2015-12-10T20:00:00Z
EndTime	string	The end of the time range during which data was queried.	2015-12-10T22:00:00Z
Type	string	The type of content.	static
Area	string	The ID of the billable region where the data was collected.	CN
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	300
UsageDataPerInterval	object
DataModule	array<object>	The resource usage that was collected at each interval.
	object	The information about resource usage that was collected at each interval.
Value	string	The amount of resource usage.	423304182
TimeStamp	string	The timestamp of the data returned. Note TimeStamp indicates the timestamp of the data returned at each interval.	2015-12-10T21:30:00Z
PeakTime	string	The time of the peak bandwidth value if the Field parameter in the request is set to bps. Otherwise, this parameter returns the same value as the TimeStamp parameter.	2015-12-10T21:30:00Z
SpecialValue	string	The resource usage in a specific scenario. Note SpecialValue indicates the data usage in a specific scenario. If no special billable item is specified, ignore this parameter.	423304182

Examples

Success response

JSON format

{
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "StartTime": "2015-12-10T20:00:00Z",
  "EndTime": "2015-12-10T22:00:00Z",
  "Type": "bps",
  "Area": "CN",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T21:30:00Z",
        "PeakTime": "2015-12-10T21:30:00Z",
        "SpecialValue": "423304182"
      }
    ]
  }
}

Error response

JSON format

http://cdn.aliyuncs.com?Action=DescribeDomainUsageData&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T22:00:00Z
&Field=bps
&Area=EU
&<公共请求参数>

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.
400	InvalidParameterType	The specified Type is invalid.	The Type parameter is set to an invalid value.
400	InvalidParameterField	The specified Field is invalid.	The Field parameter is set to an invalid value.
400	InvalidParameterStartTime	The parameter StartTime is invalid.	The specified StartTime parameter is invalid.
400	InvalidParameterEndTime	The parameter EndTime is invalid.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	StartTime must be earlier than EndTime.
400	InvalidIntervalParameter	The specified Interval is invalid.	The specified time interval is invalid.
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 value of parameter StartTime is not supported.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	The specified start or end time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.