调用DescribeLiveProducerUsageData查询导播台用量数据。
使用说明
最小数据查询粒度为1小时;最大查询时间跨度为31天;支持历史最大查询时间范围为最近90天。
QPS限制
本接口的单用户QPS限制为5次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeLiveProducerUsageData | 系统规定参数。取值:DescribeLiveProducerUsageData。 |
Region | String | 否 | cn-shanghai | 域名所属地域。 |
DomainName | String | 否 | example.com | 云导播播流域名。多个域名使用英文逗号(,)分隔。 |
Instance | String | 否 | a17d0184-462d-4630-b2a6-8c26dde2**** | 查询实例。支持批量实例查询,多个实例用英文逗号(,)分隔。 说明 若参数为空,默认返回所有实例合并后数据。 |
Type | String | 否 | slidelive | 导播类型。支持批量查询,多个类型用英文逗号(,)分隔。取值:
说明 若参数为空,默认返回所有导播类型合并后数据。 |
SplitBy | String | 否 | type | 分组键。可以指定domain、region、 instance,、type其中之一或多个, 多个使用英文逗号(,)分隔.。指定了split 的字段将会被分组输出。 说明 若参数为空, 则只输出按照聚合后数据. |
StartTime | String | 否 | 2018-09-30T16:00:00Z | 开始时间。日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
EndTime | String | 否 | 2018-10-31T15:59:59Z | 结束时间。日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 说明 结束时间需大于起始时间。 |
Interval | String | 否 | 3600 | 指定查询数据的时间粒度,支持3600(1小时)和86400(1天)的取值。单位:秒。 |
app | String | 否 | liveApp**** | 播流所属应用名称。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
BillProducerData | Array of BillProducerDataItem | 用户导播台用量数据。 |
|
BillProducerDataItem | |||
DomainName | String | example.com | 用量域名。SplitBy指定为domain时,分组输出。 |
Instance | String | a17d0184-462d-4630-b2a6-8c26dde2**** | 用量实例。SplitBy指定为instance时,分组输出。 |
OutputHdDuration | Long | 6000 | 高清分辨率时长,单位为分钟。 |
OutputLdDuration | Long | 1001 | 流畅分辨率时长,单位为分钟。 |
OutputSdDuration | Long | 500 | 标准分辨率时长,单位为分钟。 |
Region | String | cn-shanghai | 用量地区。SplitBy指定为region时,分组输出。 |
TimeStamp | String | 2018-09-30T00:00:00Z | 时间片起始时刻。 |
TranHdDuration | Long | 6777 | 转码高清分辨率时长,单位为分钟。 |
TranLdDuration | Long | 111 | 转码流畅分辨率时长,单位为分钟。 |
TranSdDuration | Long | 666 | 转码标准分辨率时长,单位为分钟。 |
Type | String | slidelive | 导播类型。SplitBy指定为type时,分组输出。 |
EndTime | String | 2018-09-30T16:00:00Z | 结束时间。 |
RequestId | String | C370DAF1-C838-4288-A1A0-9A87633D248E | 请求ID。 |
StartTime | String | 2018-10-31T15:59:59Z | 开始时间。 |
示例
请求示例
http(s)://live.aliyuncs.com?Action=DescribeLiveProducerUsageData
&StartTime=2018-09-30T16:00:00Z
&EndTime=2018-10-31T15:59:59Z
&<公共请求参数>
正常返回示例
XML
格式
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
格式
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"
} ]
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | StartTime参数错误,请您确认该StartTime参数是否正确。 |
400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 结束时间错误,请您确认结束时间是否正确。 |
400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | 结束时间与开始时间不匹配,请您确认时间的匹配度。 |
400 | InvalidTimeSpan | The time span exceeds the limit. | 时间跨度超过限制,请参照接口文档,配置合理查询跨度。 |
400 | InvalidTime.ValueNotSupported | Specified Time is malformed. | 开始时间和结束时间不匹配。 |
访问错误中心查看更多错误码。
示例2: splitBy=type
请求示例
http://live.aliyuncs.com?Action=DescribeLiveProducerUsageData
&StartTime=2018-09-30T16:00:00Z
&EndTime=2018-10-31T15:59:59Z
&SplitBy=type
&<公共请求参数>
正常返回示例
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>
<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
格式
{
"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"
}]
}
}