DescribeDcdnDomainRealTimeTrafficData - Edge Security Acceleration

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 granularity	Maximum time range per query	Historical data available	Data delay
1 minute	1 hour	7 days	5 minutes
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify one or more domain names and separate them with commas (,).	example.com
StartTime	string	No	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
EndTime	string	No	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

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2015-12-10T20:01:00Z
StartTime	string	The beginning of the time range during which data was queried.	2015-12-10T20:00:00Z
RequestId	string	The ID of the request.	A666D44F-19D6-490E-97CF-1A64AB962C57
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	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
RealTimeTrafficDataPerInterval	array<object>	The amount of back-to-origin traffic returned at each interval.
DataModule	object
Value	string	The traffic value at each time interval. Note The network traffic is measured in bytes.	0
TimeStamp	string	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 code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The 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.
400	InvalidEndTime.Malformed	The 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.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

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

Change history

Change time	Summary of changes	Operation

No change history