All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodDomainTrafficData

Last Updated:May 11, 2024

Queries the traffic data for one or more accelerated domains. The minimum time granularity is 5 minutes. You can query data in the last 366 days. Compared with the DescribeVodDomainRealTimeTrafficData operation, this operation provides a greater time granularity, higher data latency, but allows you to query historical data within a longer time period.

Operation description

  • This operation is supported only in the China (Shanghai) region.
  • You can specify a maximum of 500 accelerated domain names.
  • If you specify neither StartTime nor EndTime, the data of the last 24 hour is queried. You can specify both StartTime and EndTime parameters to query data of a specified time range.

Time granularity

The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay when you do not set Interval.

Time granularityTime range per queryHistorical data availableData delay
5 minutesTime range per query < 3 days93 days15 minutes
1 hour3 days ≤ Time range per query < 31 days186 days3 to 4 hours
1 day31 days ≤ Time range per query ≤ 366 days366 days4 hours in most cases, not more than 24 hours

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:DescribeVodDomainTrafficDataRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name.

  • If you leave this parameter empty, the merged data of all your accelerated domain names is returned.
  • You can specify multiple domain names and separate them with commas (,). You can specify a maximum of 500 domain names in each call.
example.com
StartTimestringNo

The start 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.

2019-01-20T13:59:58Z
EndTimestringNo

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.
2019-01-20T14:59:58Z
IntervalstringNo

The time granularity of the query. Unit: seconds. Valid values: 300, 3600, and 86400. If you leave this parameter empty or specify an invalid value, the default value is used. The supported time granularity varies based on the time range specified by EndTime and StartTime. The following content describes the supported time granularity.

  • Time range per query < 3 days: 300 (default), 3600, and 86400
  • 3 days ≤ Time range per query < 31 days: 3600 (default) and 86400
  • 31 days ≤ Time range per query ≤ 366 days: 86400 (default)
300
IspNameEnstringNo

The name of the Internet service provider (ISP). If you leave this parameter empty, all ISPs are queried.

Alibaba
LocationNameEnstringNo

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

ParameterTypeDescriptionExample
object

The returned result.

EndTimestring

The end of the time range.

2019-01-20T14:59:58Z
StartTimestring

The beginning of the time range.

2019-01-20T13:59:58Z
RequestIdstring

The ID of the request.

D94E471F-1A27-442E-552D-D4D2000C****
DomainNamestring

The accelerated domain name.

example.com
TotalTrafficstring

The total amount of network traffic.

5906662826
DataIntervalstring

The time interval at which data is returned, which is the time granularity. Unit: seconds.

3600
TrafficDataPerIntervalobject []

The amount of network traffic at each time interval.

HttpsDomesticValuestring

The amount of HTTPS network traffic on points of presence (POPs) in the Chinese mainland. Unit: bytes.

0
Valuestring

The total traffic. Unit: bytes.

0
OverseasValuestring

The amount of network traffic outside the Chinese mainland. Unit: bytes.

0
HttpsValuestring

The total amount of HTTPS network traffic on POPs. Unit: bytes.

0
HttpsOverseasValuestring

The amount of HTTPS network traffic on POPs outside the Chinese mainland. Unit: bytes.

0
TimeStampstring

The timestamp of the data returned. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2019-01-15T19:00:00Z
DomesticValuestring

The amount of network traffic in the Chinese mainland. Unit: bytes.

0

Examples

Sample success responses

JSONformat

{
  "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 codeError messageHTTP status codeDescription
ThrottlingRequest was denied due to request throttling.503The error message returned because the request was denied due to throttling.
IllegalOperationIllegal domain, operation is not permitted.403The error message returned because the domain name is invalid.
OperationDeniedYour account does not open CDN service yet.403The error message returned because Alibaba Cloud CDN is not activated for your Alibaba Cloud account.
OperationDeniedYour CDN service is suspended.403The error message returned because Alibaba Cloud CDN is suspended for your Alibaba Cloud account.
InvalidDomain.NotFoundThe domain provided does not belong to you.404The error message returned because the specified domain name does not exist or does not belong to the current account.
InvalidDomain.OfflineThe domain provided is offline.404The error message returned because the domain name is disabled.
ServiceBusyThe specified Domain is configuring, please retry later.403The error message returned because the domain name is being configured. Try again later.
InvalidDomain.Configure_failedFailed to configure the provided domain.500The error message returned because the system failed to configure the domain name.
MissingParameterStartTime and EndTime can not be single.400The error message returned because the StartTime and EndTime parameters are not specified at the same time.
InvalidStartTime.MalformedSpecified start time is malformed.400The error message returned because the format of the start time that is specified by the StartTime parameter is invalid.
InvalidEndTime.MalformedSpecified end time is malformed.400The error message returned because the format of the end time that is specified by the EndTime parameter is invalid.
InvalidEndTime.MismatchSpecified end time does not match the specified start time.400The error message returned because the end time is earlier than the start time.
InvalidStartTime.ValueNotSupportedSpecified end time does not match the specified start time.400The error message returned because the time range that is specified by the EndTime and StartTime parameters exceeds 90 days.