DescribeLiveDomainRealTimeBpsData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

You can call this operation to query the bandwidth usage of one or more specified domain names.
You can query data in the last seven days. The time range that is specified by the StartTime and EndTime parameters cannot exceed 24 hours for a 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

You can call this operation up to 10 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. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeLiveDomainRealTimeBpsData	The operation that you want to perform. Set the value to DescribeLiveDomainRealTimeBpsData.
DomainName	String	Yes	example.com,example.aliyundoc.com	The streaming domain. Separate multiple streaming domains with commas (,).
IspNameEn	String	No	alibaba	The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query a list of available ISPs.
LocationNameEn	String	No	tianjin	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query a list of available regions.
StartTime	String	No	2015-11-30T05:39:00Z	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.
EndTime	String	No	2015-11-30T05:40:00Z	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 specify this parameter, the data of the hour following the specified start time is returned.

Response parameters

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

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainRealTimeBpsData
&DomainName=example.com,example.aliyundoc.com
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveDomainRealTimeBpsDataResponse>
<EndTime>2015-11-30T05:40:00Z</EndTime>
<RequestId>BC858082-736F-4A25-867B-E5B67C85ACF7</RequestId>
<DomainName>example.com,example.aliyundoc.com</DomainName>
<DataInterval>60</DataInterval>
<StartTime>2015-11-30T05:33:00Z</StartTime>
<RealTimeBpsDataPerInterval>
    <DataModule>
        <Value>59392614.8</Value>
        <TimeStamp>2015-11-30T05:39:00Z</TimeStamp>
    </DataModule>
</RealTimeBpsDataPerInterval>
</DescribeLiveDomainRealTimeBpsDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.