All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnDomainRealTimeTrafficData

Last Updated:Mar 01, 2024

Queries the traffic monitoring data of an accelerated domain name. Data is collected every minute.

Operation description

You can call this operation up to 50 times per second per user.

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

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
dcdn:DescribeDcdnDomainRealTimeTrafficDataRead
  • domain
    acs:dcdn:*:{#accountId}:domain/{#domainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify one or more domain names and separate them with commas (,).

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.

Note If you do not specify StartTime or EndTime, data within the last hour is queried. If you specify both StartTime and EndTime, data within the specified time range is queried.
2015-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. The end time must be later than the start time.

Note If you do not specify StartTime or EndTime, data within the last hour is queried. If you specify both StartTime and EndTime, data within the specified time range is queried.
2015-12-10T20:01:00Z

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

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

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

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

2015-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. Unit: seconds.

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

60
RealTimeTrafficDataPerIntervalobject []

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

Valuestring

The traffic value at each time interval.

Note The network traffic is measured in bytes.
0
TimeStampstring

The timestamp of the data returned.

2015-12-10T20:00:00Z

Examples

Sample success responses

JSONformat

{
  "EndTime": "2015-12-10T20:01:00Z",
  "StartTime": "2015-12-10T20:00:00Z",
  "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "DomainName": "example.com",
  "DataInterval": "60",
  "RealTimeTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2015-12-10T20: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.

Change history

Change timeSummary of changesOperation
No change history