All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodDomainRealTimeTrafficData

更新時間:Dec 19, 2024

Queries the traffic data for one or more accelerated domains. The minimum time granularity is 1 minute. The minimum data latency is 5 minutes. You can query data in the last 186 days. Compared with the DescribeVodDomainTrafficData operation, this operation provides a smaller time granularity, lower data latency, and allows you to query historical data within a shorter time period.

Operation description

  • This operation is supported only in the China (Shanghai) region.
  • You can specify a maximum of 100 accelerated domain names.
  • If you specify neither StartTime nor EndTime, the data of the last 1 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.

Time granularityTime range per queryHistorical data availableData delay
1 minuteTime range per query ≤ 1 hour7 days5 minutes
5 minutes1 Hour < Time range per query ≤ 3 days93 days15 minutes
1 hour3 days < Time range per query ≤ 31 days186 days3 to 4 hours

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeVodDomainRealTimeTrafficDataget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

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

2019-12-10T20:00:00Z
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-12-10T20:01:00Z
IspNameEnstringNo

The name of the ISP. If you do not set this parameter, all ISPs are queried.

telecom
LocationNameEnstringNo

The name of the region. If you do not set this parameter, data in all regions is queried.

shanghai

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range.

2019-12-10T20:01:00Z
StartTimestring

The beginning of the time range.

2019-12-10T20:00:00Z
RequestIdstring

The ID of the request.

A666D44F-19D6-490E-97CF-1A64AB962C57
DomainNamestring

The accelerated domain name.

example.com
DataIntervalstring

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

The returned value varies based on the time range per query. Valid values: 60 (1 minute), 300 (5 minutes), and 3600 (1 hour). For more information, see the Time granularity section in the API documentation.

60
RealTimeTrafficDataPerIntervalarray<object>

The details of traffic data in each time interval.

DataModuleobject
Valuestring

The traffic data. Unit: bytes.

0
TimeStampstring

The timestamp of the data returned. The time follows the ISO 8601 standard. The time is displayed in UTC.

2019-12-10T20:01:00Z

Examples

Sample success responses

JSONformat

{
  "EndTime": "2019-12-10T20:01:00Z",
  "StartTime": "2019-12-10T20:00:00Z",
  "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "DomainName": "example.com",
  "DataInterval": "60",
  "RealTimeTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2019-12-10T20:01:00Z"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.