DescribeLiveDomainBpsData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

If you specify neither the StartTime parameter nor the EndTime parameter, the data of the last 24 hours is queried. You can specify both the StartTime and EndTime parameters to query the data of a specified time range.
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 data in the last 90 days.
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 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. 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	DescribeLiveDomainBpsData	The operation that you want to perform. Set the value to DescribeLiveDomainBpsData.
DomainName	String	No	example.com	The streaming domain. Separate multiple streaming domains with commas (,).
StartTime	String	No	2017-12-10T08:00: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	2017-12-10T09:00: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.
Interval	String	No	300	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.
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.

Response parameters

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

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainBpsData
&<Common request parameters>

Sample success responses

XML format

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

<DescribeLiveDomainBpsDataResponse>
    <EndTime>2017-12-10T09:00:00Z</EndTime>
    <StartTime>2017-12-10T08:00:00Z</StartTime>
    <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>
    <DomainName>example.com</DomainName>
    <DataInterval>300</DataInterval>
    <BpsDataPerInterval>
        <BpsValue>11288111</BpsValue>
        <TimeStamp>2017-12-10T08:00:05Z</TimeStamp>
        <HttpsBpsValue>2000</HttpsBpsValue>
        <HttpBpsValue>11286111</HttpBpsValue>
    </BpsDataPerInterval>
</DescribeLiveDomainBpsDataResponse>

JSON format

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

{
  "EndTime" : "2017-12-10T09:00:00Z",
  "StartTime" : "2017-12-10T08:00:00Z",
  "RequestId" : "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName" : "example.com",
  "DataInterval" : "300",
  "BpsDataPerInterval" : [ {
    "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.	The format of the start time is invalid. Check whether the value of the StartTime parameter is valid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The format of the end time is invalid. Check whether the value of the EndTime parameter is valid.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Check whether the value of the EndTime parameter matches.
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, see Service error codes.