All Products
Search
Document Center

Edge Security Acceleration:DescribeDcdnDomainOriginTrafficData

Last Updated:Oct 17, 2024

Queries the back-to-origin traffic of one or more accelerated domain names.

Operation description

  • You can call this operation up to 100 times per second per account.
  • If you do not set the StartTime or EndTime parameters, the request returns the data collected in the last 24 hours. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity supported by the Interval parameter varies with the maximum time range per query. The following table describes the time period within which historical data is available and the data delay.

Time granularityMaximum time range per queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours
1 day366 days366 days04:00 on the next day

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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name. Separate multiple accelerated domain names with commas (,). If you do not specify a value for this parameter, all accelerated domain names are queried.

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.

2017-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.
2017-12-10T21:00:00Z
IntervalstringNo

The time interval between the data entries to return. Unit: seconds.

The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Description.

300

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range during which data was queried.

2017-12-10T21:00:00Z
StartTimestring

The beginning of the time range during which data was queried.

2017-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 between the data entries returned. Unit: seconds.

300
OriginTrafficDataPerIntervalarray<object>

The amount of back-to-origin traffic returned at each time interval. Unit: bytes.

DataModuleobject
DynamicHttpOriginTrafficfloat

The amount of back-to-origin traffic that was consumed to deliver dynamic content over HTTP.

1000
StaticHttpsOriginTrafficfloat

The amount of back-to-origin traffic that was consumed to deliver static content over HTTPS.

100
OriginTrafficfloat

The amount of back-to-origin traffic.

100
StaticHttpOriginTrafficfloat

The amount of back-to-origin traffic that was consumed to deliver static content over HTTP.

0
DynamicHttpsOriginTrafficfloat

The amount of back-to-origin traffic that was consumed to deliver dynamic content over HTTPS.

500
TimeStampstring

The timestamp of the data returned.

2017-12-10T21:00:00Z

Examples

Sample success responses

JSONformat

{
  "EndTime": "2017-12-10T21:00:00Z",
  "StartTime": "2017-12-10T20:00:00Z",
  "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "DomainName": "example.com",
  "DataInterval": "300",
  "OriginTrafficDataPerInterval": {
    "DataModule": [
      {
        "DynamicHttpOriginTraffic": 1000,
        "StaticHttpsOriginTraffic": 100,
        "OriginTraffic": 100,
        "StaticHttpOriginTraffic": 0,
        "DynamicHttpsOriginTraffic": 500,
        "TimeStamp": "2017-12-10T21:00:00Z"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified StartTime parameter is invalid.The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400InvalidEndTime.MalformedThe specified EndTime is invalid.The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.The end time is earlier than the start time.
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid.

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