DescribeLiveDomainTrafficData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the network traffic data for streaming domains.

Usage notes

If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours.
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 may 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	DescribeLiveDomainTrafficData	The operation that you want to perform. Set the value to DescribeLiveDomainTrafficData.
DomainName	String	No	example.com	The streaming domain. Separate multiple streaming domains with commas (,).
StartTime	String	No	2017-12-10T14: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. Note You can query the data in the last 90 days.
EndTime	String	No	2017-12-10T15: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 do not set this parameter or the specified value is invalid, the default value 300 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-10T15:00:00Z	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.
StartTime	String	2017-12-10T14:00:00Z	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.
RequestId	String	B955107D-E658-4E77-B913-E0AC3D31693E	The ID of the request.
DomainName	String	example.com	The streaming domain.
DataInterval	String	300	The time granularity of the query.
TrafficDataPerInterval	Array of DataModule		The traffic data that was collected at each interval.
DataModule
TrafficValue	String	454680793	The total traffic. Unit: bytes.
HttpTrafficValue	String	0	The traffic over HTTP. Unit: bytes.
TimeStamp	String	2017-12-10T15:00:05Z	The timestamp of the data returned.
HttpsTrafficValue	String	454680793	The traffic over HTTPS. Unit: bytes.

Examples

Sample requests

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

Sample success responses

XML format

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

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveDomainTrafficDataResponse>
<EndTime>2017-12-10T15:00:00Z</EndTime>
<RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>
<DomainName>example.com</DomainName>
<TrafficDataPerInterval>
    <DataModule>
        <HttpTrafficValue>0</HttpTrafficValue>
        <HttpsTrafficValue>454680793</HttpsTrafficValue>
        <TrafficValue>454680793</TrafficValue>
        <TimeStamp>2017-12-10T15:00:05Z</TimeStamp>
    </DataModule>
</TrafficDataPerInterval>
<DataInterval>300</DataInterval>
<StartTime>2017-12-10T14:00:00Z</StartTime>
</DescribeLiveDomainTrafficDataResponse>

JSON format

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

{
  "DescribeLiveDomainTrafficDataResponse" : {
    "EndTime" : "2017-12-10T15:00:00Z",
    "RequestId" : "B955107D-E658-4E77-B913-E0AC3D31693E",
    "DomainName" : "example.com",
    "TrafficDataPerInterval" : {
      "DataModule" : {
        "HttpTrafficValue" : 0,
        "HttpsTrafficValue" : 454680793,
        "TrafficValue" : 454680793,
        "TimeStamp" : "2017-12-10T15:00:05Z"
      }
    },
    "DataInterval" : 300,
    "StartTime" : "2017-12-10T14:00:00Z"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The value specified for StartTime is invalid. Check whether the value of the StartTime parameter is valid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The value specified for EndTime 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 start time and end time 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, see Service error codes.