All Products
Search
Document Center

CDN:DescribeDomainRealTimeSrcTrafficData

Last Updated:May 30, 2023

Queries the monitoring data of back-to-origin traffic for one or more specified accelerated domains. The data is collected every minute.

Operation Description

  • You can call this operation up to 10 times per second per account.
  • If you do not specify the StartTime or EndTime parameter, the request returns the data collected in the last hour by default. If you specify both the StartTime and EndTime parameters, the request returns the data collected within the 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 granularityMaximum time range per queryHistorical data availableData delay
1 minute1 hour7 days5 minutes
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours

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
cdn:DescribeDomainRealTimeSrcTrafficDataREAD
  • CDN
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify up to 100 domain names in each call. Separate multiple domain names with commas (,).

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

NoteThe end time must be later than the start time.
2019-12-10T20:01:00Z

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

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

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

The start of the time range for which the data was queried.

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

Depending on the maximum time range per query, the value is 60 (1 minute), 300 (5 minutes), or 3600 (1 hour). For more information, see the "Time granularity" section in Usage notes.

60
RealTimeSrcTrafficDataPerIntervalobject []

The amount of back-to-origin traffic returned at each interval.

Valuestring

The amount of traffic.

0
TimeStampstring

The timestamp of the data returned.

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",
  "RealTimeSrcTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2019-12-10T20:01:00Z"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterStartTime and EndTime can not be single.You must specify both the start time and end time.
400InvalidStartTime.MalformedSpecified StartTime is malformed.The specified start time is invalid. For more information, see the API references.
400InvalidEndTime.MalformedSpecified EndTime is malformed.The format of the end time is invalid. Specify a valid value.
400InvalidEndTime.MismatchSpecified end time does not math the specified start time.The end time cannot be earlier than the start time
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The start time is invalid. Set this parameter to another value and try again.
400Abs.DomainName.MalformedThe size of DomainName is too big.-
400InvalidInterval.MalformedSpecified Interval is malformed.The format of the time granularity is invalid.

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