Queries the network traffic for one or more accelerated domain names.
Operation description
- This operation is available only in the China (Shanghai) region.
- You can specify multiple accelerated domain names in a request.
- If you do not specify the StartTime or EndTime parameter, data of the last 24 hours is returned. You can specify the StartTime and EndTime parameters to query data that is generated in the specified time range. You can query data of the last 90 days.
QPS limit
You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on API operations.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vod:DescribeVodDomainTrafficData | Read |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainName | string | No | The accelerated domain name that you want to query. If you leave this parameter empty, the merged data of all your accelerated domain names is returned. Separate multiple domain names with commas (,). | 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. Note
The minimum time granularity to query data is 5 minutes. If you leave this parameter empty, the data in the last 24 hours is queried.
| 2019-01-20T13:59:58Z |
EndTime | string | No | The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2019-01-20T14:59:58Z |
Interval | string | No | The interval at which to return data. Unit: seconds. Valid values: 300, 3600, and 86400. If you leave this parameter empty or specify an invalid value, the default value is used.
| 300 |
IspNameEn | string | No | The name of the Internet service provider (ISP). If you leave this parameter empty, all ISPs are queried. | Alibaba |
LocationNameEn | string | No | The name of the region. If you leave this parameter empty, all regions are queried. You can specify only the China (Shanghai) region. | cn-shanghai |
Response parameters
Examples
Sample success responses
JSON
format
{
"EndTime": "2019-01-20T14:59:58Z",
"StartTime": "2019-01-20T13:59:58Z",
"RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
"DomainName": "example.com",
"TotalTraffic": "5906662826",
"DataInterval": "3600",
"TrafficDataPerInterval": {
"DataModule": [
{
"HttpsDomesticValue": "0",
"Value": "0",
"OverseasValue": "0",
"HttpsValue": "0",
"HttpsOverseasValue": "0",
"TimeStamp": "2019-01-15T19:00:00Z",
"DomesticValue": "0"
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Common errors
The following table describes the error codes that this operation can return.
Error code | Error message | HTTP status code | Description |
---|---|---|---|
Throttling | Request was denied due to request throttling. | 503 | The error message returned because the request was denied due to throttling. |
IllegalOperation | Illegal domain, operation is not permitted. | 403 | The error message returned because the domain name is invalid. |
OperationDenied | Your account does not open CDN service yet. | 403 | The error message returned because Alibaba Cloud CDN is not activated for your Alibaba Cloud account. |
OperationDenied | Your CDN service is suspended. | 403 | The error message returned because Alibaba Cloud CDN is suspended for your Alibaba Cloud account. |
InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | The error message returned because the specified domain name does not exist or does not belong to the current account. |
InvalidDomain.Offline | The domain provided is offline. | 404 | The error message returned because the domain name is disabled. |
ServiceBusy | The specified Domain is configuring, please retry later. | 403 | The error message returned because the domain name is being configured. Try again later. |
InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | The error message returned because the system failed to configure the domain name. |
MissingParameter | StartTime and EndTime can not be single. | 400 | The error message returned because the StartTime and EndTime parameters are not specified at the same time. |
InvalidStartTime.Malformed | Specified start time is malformed. | 400 | The error message returned because the format of the start time that is specified by the StartTime parameter is invalid. |
InvalidEndTime.Malformed | Specified end time is malformed. | 400 | The error message returned because the format of the end time that is specified by the EndTime parameter is invalid. |
InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | 400 | The error message returned because the end time is earlier than the start time. |
InvalidStartTime.ValueNotSupported | Specified end time does not match the specified start time. | 400 | The error message returned because the time range that is specified by the EndTime and StartTime parameters exceeds 90 days. |