DescribeLiveDomainRealTimeBpsData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the bandwidth data that is collected every minute for one or more domain names.

Operation description

You can query the data of the last seven days. The time range that is specified by the StartTime and EndTime parameters cannot exceed 24 hours for a single query.
If you specify neither the StartTime parameter nor the EndTime parameter, the data of the last hour is returned.
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.

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

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

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain name or names. Separate multiple domain names with commas (,).	example.com,example.aliyundoc.com
IspNameEn	string	No	The name of the Internet service provider (ISP). To query ISPs, call the DescribeCdnRegionAndIsp operation.	alibaba
LocationNameEn	string	No	The name of the region in which you want to query data. To query regions, call the DescribeCdnRegionAndIsp operation.	tianjin
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.	2015-11-30T05:39:00Z
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. Note If you do not set this parameter, the data of the hour following the specified start time is returned.	2015-11-30T05:40:00Z

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range in which 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-11-30T05:40:00Z
StartTime	string	The beginning of the time range in which 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-11-30T05:33:00Z
RequestId	string	The ID of the request.	BC858082-736F-4A25-867B-E5B67C85ACF7
DomainName	string	The streaming domain name or names that was queried.	example.com,example.aliyundoc.com
DataInterval	string	The interval at which data was queried.	60
RealTimeBpsDataPerInterval	array<object>	The bandwidth data that was collected every minute.
DataModule	object
Value	string	The bandwidth. Unit: bit/s.	59392614.8
TimeStamp	string	The timestamp of the returned data.	2015-11-30T05:39:00Z

Examples

Sample success responses

JSONformat

{
  "EndTime": "2015-11-30T05:40:00Z",
  "StartTime": "2015-11-30T05:33:00Z",
  "RequestId": "BC858082-736F-4A25-867B-E5B67C85ACF7",
  "DomainName": "example.com,example.aliyundoc.com",
  "DataInterval": "60",
  "RealTimeBpsDataPerInterval": {
    "DataModule": [
      {
        "Value": "59392614.8",
        "TimeStamp": "2015-11-30T05:39:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	-
400	InvalidDomainName.Malformed	Specified domain name is malformed.	Specified domain name 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