DescribeLivePushProxyUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

You can call this operation to query the usage data of live center stream relay.
The maximum time range for a query is 31 days.
The minimum time granularity for a query is 1 day.
You can query the data in the last 90 days.

QPS limit

You can call this operation up to five 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	DescribeLivePushProxyUsageData	The operation that you want to perform. Set the value to DescribeLivePushProxyUsageData.
Region	String	No	cn-beijing	The ID of the region. Separate multiple region IDs with commas (,). Valid values: cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-shenzhen: China (Shenzhen) cn-qingdao: China (Qingdao) ap-southeast-1: Singapore eu-central-1: Germany (Frankfurt) ap-northeast-1: Japan (Tokyo) ap-south-1: India (Mumbai) ap-southeast-5: Indonesia (Jakarta) If you do not specify this parameter, data of all regions is aggregated and returned by default.
DomainName	String	No	example.com	The domain name. Separate multiple domain names with commas (,). If this parameter is left empty, the aggregated data of all domain names is returned by default.
StartTime	String	No	2022-10-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. By default, data in the last seven days is returned.
EndTime	String	No	2022-10-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. The end time must be later than the start time.
SplitBy	String	No	region	The key that is used to group data. If you do not specify this parameter, the default value region is used. Data is aggregated and returned. Separate multiple keys with commas (,). Valid values: domain: The DomainName parameter is available in the response only if SplitBy is set to domain. region: The Region parameter is available in the response only if SplitBy is set to region.

Response parameters

Parameter	Type	Example	Description
EndTime	String	2022-10-10T21:00:00Z	The end of the time range during which the usage data was queried.
StartTime	String	2022-10-10T20:00:00Z	The beginning of the time range during which the usage data was queried.
RequestId	String	4B460F8B-993C-4F48-B98A-910811DEBFEB	The request ID.
PushProxyData	Array of PushProxyDataItem		Details about the usage data of live center stream relay.
PushProxyDataItem
TimeStamp	String	2022-10-10T20:00:00Z	The timestamp of the data returned.
StreamCount	Long	8	The peak number of live center stream relay channels.
DomainName	String	example.com	The domain name. If SplitBy is set to domain, the data returned is grouped by domain name.
Region	String	cn-beijing	The ID of the region. If SplitBy is set to region, the data returned is grouped by region.

Examples

Sample requests

http://live.aliyuncs.com?Action=DescribeLiveProducerUsageData
&StartTime=2018-09-30T16:00:00Z
&EndTime=2018-10-31T15:59:59Z
&SplitBy=domain
&<Common request parameters>

Sample success responses

XML format

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

<DescribeLivePushProxyUsageDataResponse>
    <RequestId>C370DAF1-C838-4288-A1A0-9A87633D248E</RequestId>
    <EndTime>2018-09-30T16:00:00Z</EndTime>
    <StartTime>2018-10-31T15:59:59Z</StartTime>
    <PushProxyData>
        <PushProxyDataItem>
            <Domain>example.com</Domain>
            <StreamCount>6777</StreamCount>
            <TimeStamp>2018-09-30T00:00:00Z</TimeStamp>
        </PushProxyDataItem>
        <PushProxyDataItem>
            <Domain>example.com</Domain>
            <StreamCount>6777</StreamCount>
            <TimeStamp>2018-09-30T00:00:00Z</TimeStamp>
        </PushProxyDataItem>
        <PushProxyDataItem>
            <Domain>example.com</Domain>
            <StreamCount>6777</StreamCount>
            <TimeStamp>2018-10-01T00:00:00Z</TimeStamp>
        </PushProxyDataItem>
        <PushProxyDataItem>
            <Domain>example.com</Domain>
            <StreamCount>6777</StreamCount>
            <TimeStamp>2018-10-01T00:00:00Z</TimeStamp>
        </PushProxyDataItem>
    </PushProxyData>
</DescribeLivePushProxyUsageDataResponse>

JSON format

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

{
  "RequestId" : "C370DAF1-C838-4288-A1A0-9A87633D248E",
  "EndTime" : "2018-09-30T16:00:00Z",
  "StartTime" : "2018-10-31T15:59:59Z",
  "PushProxyData" : {
    "PushProxyDataItem" : [ {
      "Domain" : "example.com",
      "StreamCount" : 6777,
      "TimeStamp" : "2018-09-30T00:00:00Z"
    }, {
      "Domain" : "example.com",
      "StreamCount" : 6777,
      "TimeStamp" : "2018-09-30T00:00:00Z"
    }, {
      "Domain" : "example.com",
      "StreamCount" : 6777,
      "TimeStamp" : "2018-10-01T00:00:00Z"
    }, {
      "Domain" : "example.com",
      "StreamCount" : 6777,
      "TimeStamp" : "2018-10-01T00:00:00Z"
    } ]
  }
}

Error codes

HttpCode	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The error message returned because 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 error message returned because 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 error message returned because the end time does not match the start time. Check whether the value of the EndTime parameter matches.
400	InvalidTimeSpan	The time span exceeds the limit.	The error message returned because the time range exceeds the limit. Configure a valid time range to query.
400	InvalidTime.ValueNotSupported	Specified Time is malformed.	The error message returned because the start time and end time do not match.

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