DescribeLiveDomainPushTrafficData - ApsaraVideo Live

Queries the traffic data for one or more ingest domains.

Usage notes

The traffic unit is bytes.
You can specify multiple domain names by separating them with commas (,).
If you do not specify the StartTime or 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.
You can query data in the last 90 days.

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	DescribeLiveDomainPushTrafficData	The operation that you want to perform. Set the value to DescribeLiveDomainPushTrafficData.
DomainName	String	No	demo.aliyundoc.com	The ingest domain. You can specify multiple domain names by separating them with commas (,). If you do not specify this parameter, the merged data of all your ingest domains is returned.
StartTime	String	No	2017-12-10T20: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. If you do not specify this parameter, the data of the last 24 hours is returned.
EndTime	String	No	2017-12-10T21:00:00Z	The end 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.
Interval	String	No	300	The time granularity of the query. Unit: seconds. Valid values: 300 3600 86400 The default value is 300. If you specify an invalid value or do not specify this parameter, the default value is used.
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. If you do not specify this parameter, the data of all ISPs is returned.
LocationNameEn	String	No	tianjin	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query a list of available regions. If you do not specify this parameter, the data of all regions is returned.

Response parameters

Parameter	Type	Example	Description
EndTime	String	2017-12-10T21:00:00Z	The end of the time range during which data was queried.
StartTime	String	2017-12-10T20:00:00Z	The beginning of the time range during which data was queried.
RequestId	String	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F	The request ID.
DomainName	String	demo.aliyundoc.com	The ingest domain.
DataInterval	String	300	The time granularity.
TrafficDataPerInterval	Array of DataModule		The traffic data that was collected at each interval.
DataModule
TrafficValue	String	1288111	The traffic. Unit: bytes.
TimeStamp	String	2017-12-10T20:05:00Z	The timestamp of the data returned.

Examples

Sample requests

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

Sample success responses

XML format

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

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveDomainPushTrafficDataResponse>
<EndTime>2017-12-10T21:00:00Z</EndTime>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
<DomainName>demo.aliyundoc.com</DomainName>
<TrafficDataPerInterval>
    <DataModule>
        <TrafficValue>1288111</TrafficValue>
        <TimeStamp>2017-12-10T20:05:00Z</TimeStamp>
    </DataModule>
</TrafficDataPerInterval>
<DataInterval>300</DataInterval>
<StartTime>2017-12-10T20:00:00Z</StartTime>
</DescribeLiveDomainPushTrafficDataResponse>

JSON format

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

{
  "DescribeLiveDomainPushTrafficDataResponse" : {
    "EndTime" : "2017-12-10T21:00:00Z",
    "RequestId" : "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
    "DomainName" : "demo.aliyundoc.com",
    "TrafficDataPerInterval" : {
      "DataModule" : {
        "TrafficValue" : 1288111,
        "TimeStamp" : "2017-12-10T20:05:00Z"
      }
    },
    "DataInterval" : 300,
    "StartTime" : "2017-12-10T20:00:00Z"
  }
}

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.