Queries the usage data of domain names in a specific billing region.
Operation description
Call frequency per user: 10 calls per second.
Supported time granularity: Depending on the maximum time span of a single query, the Interval request parameter supports different time granularities for queried data. The corresponding time range of queryable historical data and data latency are as follows:
| Time granularity | Maximum time span of a single query | Queryable historical data time range | Data latency |
| 5 minutes | 3 days | 93 days | 15 minutes |
| 1 hour | 7 days | 186 days | Generally 3 to 4 hours |
| 1 day | 31 days | 366 days | Generally 4 hours, up to 24 hours |
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
cdn:DescribeDomainUsageData |
none |
*Domain
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DomainName |
string |
No |
The accelerated domain name to query. You can specify multiple domain names separated by commas (,). A maximum of 100 domain names can be specified in a single query. Note
If this parameter is left empty, the merged data of all accelerated domain names under the account is returned by default. |
example.com |
| StartTime |
string |
Yes |
The start time of the data to query. Specify the time in the ISO 8601 standard in UTC. The format is yyyy-MM-ddTHH:mm:ssZ. Note
The time granularity of the queried data is 5 minutes. |
2015-12-10T20:00:00Z |
| EndTime |
string |
Yes |
The end time of the data 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, and the time span cannot exceed 31 days. |
2015-12-10T22:00:00Z |
| Field |
string |
Yes |
The data type to query. Valid values:
Note
acc does not support queries based on the Area parameter. |
bps |
| Type |
string |
No |
The type of usage data to query. Valid values:
|
static |
| DataProtocol |
string |
No |
The protocol of the data to query. Valid values:
|
all |
| Area |
string |
No |
The region code. Valid values:
|
CN |
| Interval |
string |
No |
The time granularity of the data to query, in seconds. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day).
|
300 |
| ServiceType |
string |
No |
Parameter combinations
The following table describes the mappings between billing data and parameter values. For more information about how to call the operation, see the sample requests.
| Billing data | DataProtocol | Type | Field | Area |
| Traffic | all or not specified | all or not specified | traf | CN, OverSeas, AP1, AP2, AP3, NA, SA, EU, MEAA |
| Bandwidth | all or not specified | all or not specified | bps | CN, OverSeas, AP1, AP2, AP3, NA, SA, EU, MEAA |
| HTTPS request 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 request for dynamic content (resources) | quic | dynamic | acc | all |
| QUIC request for static content (resources) | quic | static | acc | all |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The list of parameters. |
||
| RequestId |
string |
The request ID. |
B955107D-E658-4E77-B913-E0AC3D31693E |
| DomainName |
string |
The accelerated domain name. |
example.com |
| StartTime |
string |
The start time. The time is displayed in the ISO 8601 standard in UTC. |
2015-12-10T20:00:00Z |
| EndTime |
string |
The end time. The time is displayed in the ISO 8601 standard in UTC. |
2015-12-10T22:00:00Z |
| Type |
string |
The usage type. |
bps |
| Area |
string |
The usage region. |
CN |
| DataInterval |
string |
The time interval of each record, in seconds. |
300 |
| UsageDataPerInterval |
object |
||
| DataModule |
array<object> |
The usage data for each time interval. |
|
|
object |
The usage data for each time interval. |
||
| Value |
string |
The usage value. |
423304182 |
| TimeStamp |
string |
The start time of the time slice. Note
Multiple TimeStamp values returned in the data are called time slices. The time is displayed in the ISO 8601 standard in UTC. |
2015-12-10T21:30:00Z |
| PeakTime |
string |
The time when the peak bandwidth is reached if Field is set to bps. Otherwise, the value is the same as TimeStamp. |
2015-12-10T21:30:00Z |
| SpecialValue |
string |
The special usage. Note
This parameter is used to mark the usage value in special cases. You can ignore this parameter if no special billing is involved. |
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 codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | An exception occurred while deleting the live streaming region. |
| 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. | The EndTime parameter 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.