Queries the production studio usage data.
Usage note
The minimum time granularity for a query is 1 hour. The maximum time range for a query is 31 days. You can query the production studio usage data over 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 limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeLiveProducerUsageData |
The operation that you want to perform. Set the value to DescribeLiveProducerUsageData. |
RegionId | String | No | cn-shanghai |
The ID of the region that you want to query. You can specify one or more regions. Separate multiple regions with commas (,). Note If you do not set this parameter, the production studio usage data in all regions
is returned.
|
Region | String | No | cn-shanghai |
The ID of the region where the domain name resides. |
DomainName | String | No | example.com |
The streaming domain of the production studio. Separate multiple streaming domains with commas (,). |
Instance | String | No | a17d0184-462d-4630-b2a6-8c26dde2**** |
The production studio instance that you want to query. You can specify one or more production studio instances. Separate multiple instances with commas (,). Note If you do not set this parameter, the usage data of all production studio instances
is returned.
|
Type | String | No | slidelive |
The type of the production studio. You can specify one or more production studio types. Separate multiple types with commas (,). Valid values:
Note If you do not set this parameter, the usage data of all types of production studios
is returned.
|
SplitBy | String | No | type |
The key that is used to group data. You can specify one or more keys. Separate multiple keys with commas (,). Valid values: domain, region, instance, and type. The data for a key that you specify by using the SplitBy parameter is returned by group. Note If you do not set this parameter, the aggregated data is returned.
|
StartTime | String | No | 2018-09-30T16: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 | 2018-10-31T15:59:59Z |
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. Note The end time must be later than the start time.
|
Interval | String | No | 3600 |
The time granularity for a query. Valid values: 3600 and 86400. Unit: seconds. |
app | String | No | liveApp**** |
The name of the application to which the live stream belongs. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
EndTime | String | 2018-09-30T16:00:00Z |
The end of the time range during which data was queried. |
StartTime | String | 2018-10-31T15:59:59Z |
The beginning of the time range during which data was queried. |
RequestId | String | C370DAF1-C838-4288-A1A0-9A87633D248E |
The ID of the request. |
BillProducerData | Array of BillProducerDataItem |
The production studio usage data. |
|
BillProducerDataItem | |||
TranSdDuration | Long | 666 |
The duration of standard definition transcoding. Unit: minutes. |
Type | String | slidelive |
The type of the production studio. If type is specified by the SplitBy parameter, the usage data is returned based on different types of production studios. |
TranLdDuration | Long | 111 |
The duration of low definition transcoding. Unit: minutes. |
Instance | String | a17d0184-462d-4630-b2a6-8c26dde2**** |
The production studio instance. If instance is specified by the SplitBy parameter, the usage data is returned based on different production studio instances. |
TranHdDuration | Long | 6777 |
The duration of high definition transcoding. Unit: minutes. |
Region | String | cn-shanghai |
The region. If region is specified by the SplitBy parameter, the usage data is returned based on different regions. |
TimeStamp | String | 2018-09-30T00:00:00Z |
The timestamp of the returned data. |
OutputHdDuration | Long | 6000 |
The duration of high definition streaming. Unit: minutes. |
OutputSdDuration | Long | 500 |
The duration of standard definition streaming. Unit: minutes. |
DomainName | String | example.com |
The domain name. If domain is specified by the SplitBy parameter, the usage data is returned based on different domain names. |
OutputLdDuration | Long | 1001 |
The duration of low definition streaming. Unit: minutes. |
Examples
Sample requests
http(s)://live.aliyuncs.com?Action=DescribeLiveProducerUsageData
&StartTime=2018-09-30T16:00:00Z
&EndTime=2018-10-31T15:59:59Z
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeLiveProducerUsageDataResponse>
<RequestId>C370DAF1-C838-4288-A1A0-9A87633D248E</RequestId>
<EndTime>2018-09-30T16:00:00Z</EndTime>
<StartTime>2018-10-31T15:59:59Z</StartTime>
<BillProducerData>
<BillProducerDataItem>
<OutputLdDuration>1001</OutputLdDuration>
<OutputSdDuration>500</OutputSdDuration>
<OutputHdDuration>6000</OutputHdDuration>
<TranLdDuration>111</TranLdDuration>
<TranSdDuration>666</TranSdDuration>
<TranHdDuration>6777</TranHdDuration>
<TimeStamp>2018-09-30T00:00:00Z</TimeStamp>
</BillProducerDataItem>
<BillProducerDataItem>
<OutputLdDuration>1001</OutputLdDuration>
<OutputSdDuration>500</OutputSdDuration>
<OutputHdDuration>6000</OutputHdDuration>
<TranLdDuration>111</TranLdDuration>
<TranSdDuration>666</TranSdDuration>
<TranHdDuration>6777</TranHdDuration>
<TimeStamp>2018-10-01T00:00:00Z</TimeStamp>
</BillProducerDataItem>
<BillProducerDataItem>
<OutputLdDuration>1001</OutputLdDuration>
<OutputSdDuration>500</OutputSdDuration>
<OutputHdDuration>6000</OutputHdDuration>
<TranLdDuration>111</TranLdDuration>
<TranSdDuration>666</TranSdDuration>
<TranHdDuration>6777</TranHdDuration>
<TimeStamp>2018-10-02T00:00:00Z</TimeStamp>
</BillProducerDataItem>
</BillProducerData>
</DescribeLiveProducerUsageDataResponse>
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",
"BillProducerData" : {
"BillProducerDataItem" : [ {
"OutputLdDuration" : 1001,
"OutputSdDuration" : 500,
"OutputHdDuration" : 6000,
"TranLdDuration" : 111,
"TranSdDuration" : 666,
"TranHdDuration" : 6777,
"TimeStamp" : "2018-09-30T00:00:00Z"
}, {
"OutputLdDuration" : 1001,
"OutputSdDuration" : 500,
"OutputHdDuration" : 6000,
"TranLdDuration" : 111,
"TranSdDuration" : 666,
"TranHdDuration" : 6777,
"TimeStamp" : "2018-10-01T00:00:00Z"
}, {
"OutputLdDuration" : 1001,
"OutputSdDuration" : 500,
"OutputHdDuration" : 6000,
"TranLdDuration" : 111,
"TranSdDuration" : 666,
"TranHdDuration" : 6777,
"TimeStamp" : "2018-10-02T00:00:00Z"
} ]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | The error message returned because 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 error message returned because 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 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. For more information, see the API reference. |
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, visit the API Error Center.
Example 2: Set SplitBy to type
Sample requests
http://live.aliyuncs.com?Action=DescribeLiveProducerUsageData
&StartTime=2018-09-30T16:00:00Z
&EndTime=2018-10-31T15:59:59Z
&SplitBy=type
&<Common request parameters>
Sample success responses
XML
format
<DescribeLiveProducerUsageDataResponse>
<RequestId>C370DAF1-C838-4288-A1A0-9A87633D248E</RequestId>
<EndTime>2018-09-30T16:00:00Z</EndTime>
<StartTime>2018-10-31T15:59:59Z</StartTime>
<BillProducerData>
<BillProducerDataItem>
<Type>universal</Type>
<OutputLdDuration>1001</OutputLdDuration>
<OutputSdDuration>500</OutputSdDuration>
<OutputHdDuration>6000</OutputHdDuration>
<TranLdDuration>111</TranLdDuration>
<TranSdDuration>666</TranSdDuration>
<TranHdDuration>6777</TranHdDuration>
<TimeStamp>2018-09-30T00:00:00Z</TimeStamp>
</BillProducerDataItem>
<BillProducerDataItem>
<Type>slidelive</Type>
<OutputLdDuration>1001</OutputLdDuration>
<OutputSdDuration>500</OutputSdDuration>
<OutputHdDuration>6000</OutputHdDuration>
<TranLdDuration>111</TranLdDuration>
<TranSdDuration>666</TranSdDuration>
<TranHdDuration>6777</TranHdDuration>
<TimeStamp>2018-09-30T00:00:00Z</TimeStamp>
</BillProducerDataItem>
<BillProducerDataItem>
<Type>universal</Type>
<OutputLdDuration>1001</OutputLdDuration>
<OutputSdDuration>500</OutputSdDuration>
<OutputHdDuration>6000</OutputHdDuration>
<TranLdDuration>111</TranLdDuration>
<TranSdDuration>666</TranSdDuration>
<TranHdDuration>6777</TranHdDuration>
<TimeStamp>2018-10-01T00:00:00Z</TimeStamp>
</BillProducerDataItem>
<BillProducerDataItem>
<Type>slidelive</Type>
<OutputLdDuration>1001</OutputLdDuration>
<OutputSdDuration>500</OutputSdDuration>
<OutputHdDuration>6000</OutputHdDuration>
<TranLdDuration>111</TranLdDuration>
<TranSdDuration>666</TranSdDuration>
<TranHdDuration>6777</TranHdDuration>
<TimeStamp>2018-10-01T00:00:00Z</TimeStamp>
</BillProducerDataItem>
<BillProducerDataItem>
<Type>universal</Type>
<OutputLdDuration>1001</OutputLdDuration>
<OutputSdDuration>500</OutputSdDuration>
<OutputHdDuration>6000</OutputHdDuration>
<TranLdDuration>111</TranLdDuration>
<TranSdDuration>666</TranSdDuration>
<TranHdDuration>6777</TranHdDuration>
<TimeStamp>2018-10-02T00:00:00Z</TimeStamp>
</BillProducerDataItem>
<BillProducerDataItem>
<Type>slidelive</Type>
<OutputLdDuration>1001</OutputLdDuration>
<OutputSdDuration>500</OutputSdDuration>
<OutputHdDuration>6000</OutputHdDuration>
<TranLdDuration>111</TranLdDuration>
<TranSdDuration>666</TranSdDuration>
<TranHdDuration>6777</TranHdDuration>
<TimeStamp>2018-10-02T00:00:00Z</TimeStamp>
</BillProducerDataItem>
</BillProducerData>
</DescribeLiveProducerUsageDataResponse>
JSON
format
{
"RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",
"EndTime": "2018-09-30T16:00:00Z",
"StartTime": "2018-10-31T15:59:59Z",
"BillProducerData": {
"BillProducerDataItem": [
{
"Type": "universal",
"OutputLdDuration": 1001,
"OutputSdDuration": 500,
"OutputHdDuration": 6000,
"TranLdDuration": 111,
"TranSdDuration": 666,
"TranHdDuration": 6777,
"TimeStamp": "2018-09-30T00:00:00Z"
}, {
"Type": "slidelive",
"OutputLdDuration": 1001,
"OutputSdDuration": 500,
"OutputHdDuration": 6000,
"TranLdDuration": 111,
"TranSdDuration": 666,
"TranHdDuration": 6777,
"TimeStamp": "2018-09-30T00:00:00Z"
},{
"Type": "universal",
"OutputLdDuration": 1001,
"OutputSdDuration": 500,
"OutputHdDuration": 6000,
"TranLdDuration": 111,
"TranSdDuration": 666,
"TranHdDuration": 6777,
"TimeStamp": "2018-10-01T00:00:00Z"
},{
"Type": "slidelive",
"OutputLdDuration": 1001,
"OutputSdDuration": 500,
"OutputHdDuration": 6000,
"TranLdDuration": 111,
"TranSdDuration": 666,
"TranHdDuration": 6777,
"TimeStamp": "2018-10-01T00:00:00Z"
},{
"Type": "universal",
"OutputLdDuration": 1001,
"OutputSdDuration": 500,
"OutputHdDuration": 6000,
"TranLdDuration": 111,
"TranSdDuration": 666,
"TranHdDuration": 6777,
"TimeStamp": "2018-10-02T00:00:00Z"
},{
"Type": "slidelive",
"OutputLdDuration": 1001,
"OutputSdDuration": 500,
"OutputHdDuration": 6000,
"TranLdDuration": 111,
"TranSdDuration": 666,
"TranHdDuration": 6777,
"TimeStamp": "2018-10-02T00:00:00Z"
}]
}
}