DescribeLiveDomainRealTimeTrafficData - ApsaraVideo Live

Queries the network traffic data that is collected in real time for one or more domain names.

Operation description

Usage notes

You can call this operation to query the real-time traffic in a region for an Internet service provider (ISP) within a specified period of time under one or more streaming domains.
If you do not specify the StartTime parameter or the EndTime parameter, the data of the last hour is returned. You can specify both the StartTime and EndTime parameters to query the data of a specified time range.
This operation is called to monitor data. The data is collected and processed in a manner different from that for billing. Therefore, the data that is returned by this operation cannot be used as a reference to calculate the resource usage for billing.
You can query data in the last 90 days.

QPS limit

This operation does not have a queries per second (QPS) limit on a single user. You can call this operation based on your business requirements. For more information, see QPS limits.

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
live:DescribeLiveDomainRealTimeTrafficData	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain. Separate multiple streaming domains with commas (,).	example.com,example.aliyundoc.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 this parameter, the data of the last hour is returned.	2015-12-10T15:00:00Z
IspNameEn	string	No	The name of the ISP. You can call the DescribeCdnRegionAndIsp operation to query a list of available ISPs.	alibaba
LocationNameEn	string	No	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query a list of available regions.	tianjin
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2015-12-10T15:01:00Z

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which the data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-10T15:01:00Z
StartTime	string	The beginning of the time range during which the data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-10T15:00:00Z
RequestId	string	The request ID.	A666D44F-19D6-490E-97CF-1A64AB962C57
DomainName	string	The streaming domain.	example.com,example.aliyundoc.com
DataInterval	string	The time interval between the entries returned. Unit: seconds	60
RealTimeTrafficDataPerInterval	array<object>	The traffic that was collected at each interval.
DataModule	object
Value	string	The traffic. Unit: bytes.	0
TimeStamp	string	The timestamp of the data returned. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-10T15:01:00Z

Examples

Sample success responses

JSONformat

{
  "EndTime": "2015-12-10T15:01:00Z",
  "StartTime": "2015-12-10T15:00:00Z",
  "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "DomainName": "example.com,example.aliyundoc.com",
  "DataInterval": "60",
  "RealTimeTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2015-12-10T15:01:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	StartTime and EndTime can not be single.	-
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	-
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	-
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.
400	Abs.DomainName.Malformed	The size of DomainName is too big.	-
400	InvalidInterval.Malformed	Specified Interval is malformed.	-

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

Change history

Change time	Summary of changes	Operation
2024-09-29	API Description Update. The Error code has changed	View Change Details