DescribeDomainRealTimeTrafficData - CDN - Alibaba Cloud Documentation Center

Queries the monitoring data of network traffic for one or more accelerated domain names.

Operation description

You can call this operation up to 50 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. 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 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

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.

Operation	Access level	Resource type	Condition key	Associated operation
cdn:DescribeDomainRealTimeTrafficData	none	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify up to 100 domain names in each call. Separate multiple domain names 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.	2019-12-10T20:00:00Z
IspNameEn	string	No	The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query the most recent region list. If you do not set this parameter, all regions are queried.	telecom
LocationNameEn	string	No	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query the most recent region list. If you do not set this parameter, all regions are queried.	beijing
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. Note The end time must be later than the start time.	2019-12-10T20:01:00Z

Response parameters

Parameter	Type	Description	Example
	object	The description of the parameter.
EndTime	string	The end of the time range during which data was queried.	2019-12-10T20:01:00Z
StartTime	string	The start of the time range during which data was queried.	2019-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 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
RealTimeTrafficDataPerInterval	array<object>	The network traffic returned at each time interval. Unit: bytes.
DataModule	object	The traffic that was collected at each interval.
Value	string	The traffic value at each time interval.	0
TimeStamp	string	The timestamp of the returned data.	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

HTTP status code	Error code	Error message	Description
400	MissingParameter	StartTime and EndTime can not be single.	You must specify both the start time and end time.
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.	The specified start time is invalid. For more information, see the help documentation of this operation.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.	The specified EndTime parameter is invalid.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	StartTime must be earlier than EndTime.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The start time is invalid. Set this parameter to another value and try again.
400	InvalidDomainName.Overlimit	Too many DomainNames are specified.	The number of specified domain names exceeds the limit of the operation.
400	InvalidInterval.Malformed	Specified Interval is malformed.	The format of the time granularity is invalid.

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

Change history

Change time	Summary of changes	Operation
2023-06-13	The Error code has changed	View Change Details