Queries the traffic or bandwidth data for one or more domain names for CDN.
Operation Description
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action
Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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 keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
Operate | access level | Resource type | conditional keyword | Association operation |
---|---|---|---|---|
vod:DescribeVodDomainUsageData | Read |
|
| without |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainName | string | No | The domain name for CDN. If you do not specify this parameter, the merged data of all your domain names for CDN is returned. You can specify multiple domain names. Separate them with commas (,). | 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. | 2015-12-10T10:20:00Z |
EndTime | string | Yes | 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. | 2015-12-10T12:20:00Z |
Type | string | No | The type of the content based on which the data is generated. Valid values:
| static |
Area | string | No | The region where the data is queried. The default value is CN, which indicates mainland China. Valid values:
| CN |
Field | string | Yes | The type of the data to be queried. Valid values:
| bps |
Response parameters
Example
Normal return example
JSON
Format
{
"EndTime": "2015-12-10T12:20:00Z",
"Type": "static",
"StartTime": "2015-12-10T10:20:00Z",
"RequestId": "B955107D-E658-4E77-****-E0AC3D31693E",
"Area": "CN",
"DomainName": "example.com",
"DataInterval": "300",
"UsageDataPerInterval": [
{
"Value": "2592.3920000000003",
"TimeStamp": "2015-12-10T10:00:00Z"
}
]
}
Error codes
For a list of error codes, visit the API error center.
Common errors
The following table describes the common errors 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 has not been activated for your Alibaba Cloud account. |
OperationDenied | Your CDN service is suspended. | 403 | The error message returned because Alibaba Cloud CDN has been suspended for your Alibaba Cloud account. |
InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | The error message returned because the specified CDN domain does not exist or does not belong to you. |
InvalidDomain.Offline | The domain provided is offline. | 404 | The error message returned because the domain name has been 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. |
InvalidParameter | Invalid Parameter. | 400 | The error message returned because one or more parameters are invalid. |
InvalidParameterProduct | Invalid Parameter Product. | 400 | The error message returned because the value of the Product parameter is invalid. |
InvalidParameterArea | Invalid Parameter Area. | 400 | The error message returned because the value of the Area parameter is invalid. |
InvalidParameterField | Invalid Parameter Field. | 400 | The error message returned because the value of the Field parameter is invalid. |
InvalidParameterStartTime | Invalid Parameter StartTime. | 400 | The error message returned because the value of the StartTime parameter is invalid. |
InvalidParameterEndTime | Invalid Parameter EndTime. | 400 | The error message returned because the value of the EndTime parameter is invalid. |
InvalidTimeRange | StartTime and EndTime range should less than 1 month. | 400 | The error message returned because the time range that is specified by the StartTime and EndTime parameters exceeds 31 days. |
InvalidParameterInterval | Invalid Parameter Interval. | 400 | The error message returned because the value of the Interval parameter is invalid. |