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

Usage note

  • 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

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 name or names.

Separate multiple domain names with commas (,).

IspNameEn String No alibaba

The name of the Internet service provider (ISP).

To query ISPs, call the DescribeCdnRegionAndIsp operation.

LocationNameEn String No tianjin

The name of the region in which you want to query data.

To query regions, call the DescribeCdnRegionAndIsp operation.

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 set this parameter, the data of the hour following the specified start time is returned.

Response parameters

Parameter Type Example Description
DataInterval String 60

The interval at which data was queried.

DomainName String example.com,example.aliyundoc.com

The streaming domain name or names that was queried.

EndTime String 2015-11-30T05:40:00Z

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.

RealTimeBpsDataPerInterval Array of DataModule

The bandwidth data that was collected every minute.

DataModule
TimeStamp String 2015-11-30T05:39:00Z

The timestamp of the returned data.

Value String 59392614.8

The bandwidth. Unit: bit/s.

RequestId String BC858082-736F-4A25-867B-E5B67C85ACF7

The ID of the request.

StartTime String 2015-11-30T05:33:00Z

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.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeLiveDomainRealTimeBpsDataResponse>
      <RealTimeBpsDataPerInterval>
            <DataModule>
                  <TimeStamp>2018-01-02T11:05:00Z</TimeStamp>
                  <Value>16710625.733333332</Value>
            </DataModule>
            <DataModule>
                  <TimeStamp>2018-01-02T11:04:00Z</TimeStamp>
                  <Value>59392614.8</Value>
            </DataModule>
      </RealTimeBpsDataPerInterval>
      <RequestId>B49E6DDA-F413-422B-B58E-2FA23F286726</RequestId>
      <DomainName>example.com,example.aliyundoc.com</DomainName>
      <EndTime>2017-12-10T15:00:00Z</EndTime>
      <DataInterval>300</DataInterval>
      <StartTime>2017-12-10T14:00:00Z</StartTime>
</DescribeLiveDomainRealTimeBpsDataResponse>

JSON format

{
   "RealTimeBpsDataPerInterval":{
      "DataModule":[
         {
            "TimeStamp":"2018-01-02T11:05:00Z",
            "Value":16710625.733333332
         },
         {
            "TimeStamp":"2018-01-02T11:04:00Z",
            "Value":59392614.8
         }
      ]
   },
   "RequestId":"B49E6DDA-F413-422B-B58E-2FA23F286726",
   "DomainName":"example.com,example.aliyundoc.com",
   "EndTime":"2017-12-10T15:00:00Z",
   "DataInterval":"300",
   "StartTime":"2017-12-10T14:00:00Z"
}

Error codes

For a list of error codes, visit the API Error Center.