DescribeLiveDomainBpsData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the bandwidth data for one or more streaming domains.

Operation description

You can specify both the StartTime and EndTime parameters to query the data in the specified period of time. If you do not specify the StartTime and EndTime parameters, the data of the last hour is queried by default.
If you specify only the StartTime parameter but not the EndTime parameter, the data of the hour following the specified start time is queried.
If you specify only the EndTime parameter but not the StartTime parameter, the data of the hour preceding the specified end time is queried.
You can query the data in the last 90 days.
This operation is used to monitor data. The data returned by this operation cannot be used as a reference to calculate resource usage for billing.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The streaming domain. You can query one or more domain names. If you specify multiple domain names, separate them with commas (,). If you leave this parameter empty, the data of all domain names within your Alibaba Cloud account is returned.	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.	2017-12-10T08:00: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.	2017-12-10T09:00:00Z
Interval	string	No	The time granularity of the query. Unit: seconds. Valid values: 300 (default) 3600 86400 Note If you specify an invalid value or do not specify this parameter, the default value 300 is used. When the time granularity is 300 seconds, the returned bandwidth is the average bandwidth within the 300 seconds. When the time granularity is 3600 or 86400 seconds, the returned bandwidth is the peak value of all average bandwidths within each 300-second period.	300
IspNameEn	string	No	The name of the Internet service provider (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

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.	2017-12-10T09:00: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.	2017-12-10T08:00:00Z
RequestId	string	The request ID.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	The streaming domain.	example.com
DataInterval	string	The time granularity of the query. Unit: seconds.	300
BpsDataPerInterval	array<object>	The bandwidth data returned at each interval.
DataModule	object	The bandwidth data returned at each interval.
BpsValue	string	The bandwidth. Unit: bit/s.	11288111
TimeStamp	string	The timestamp of the data returned.	2017-12-10T08:00:05Z
HttpsBpsValue	string	The bandwidth over HTTPS. Unit: bit/s.	2000
HttpBpsValue	string	The bandwidth over HTTP. Unit: bit/s.	11286111

Examples

Sample success responses

JSONformat

{
  "EndTime": "2017-12-10T09:00:00Z",
  "StartTime": "2017-12-10T08:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "BpsValue": "11288111",
        "TimeStamp": "2017-12-10T08:00:05Z",
        "HttpsBpsValue": "2000",
        "HttpBpsValue": "11286111"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.

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