调用DescribeLiveStreamsPublishList获取某一时间段内某个域名(或域名下某应用或某个流)的历史推流记录。
使用说明
调用本接口最多可查询近30天的历史流。返回的数据为查询时间段内的在线流信息。本接口目前支持以下排序方式:
- stream_name_desc:按直播流名称倒序。
- stream_name_asc:按直播流名称升序。
- publish_time_desc:按推流时间倒序。
- publish_time_asc:按推流时间升序。
QPS限制
本接口的单用户QPS限制为3次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeLiveStreamsPublishList | 系统规定参数。取值:DescribeLiveStreamsPublishList。 |
DomainName | String | 是 | example.com | 推流域名或主播流域名。 |
AppName | String | 否 | liveApp**** | 播流所属应用名称。 |
StreamName | String | 否 | liveStream**** | 播流名称。 |
StartTime | String | 是 | 2017-12-21T08:00:00Z | 推流时间。 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
EndTime | String | 是 | 2017-12-22T08:00:00Z | 结束时间。EndTime和StartTime之间的间隔不能超过30天。 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
PageSize | Integer | 否 | 1500 | 分页大小。取值范围:1~3000,默认值为2000。 |
PageNumber | Integer | 否 | 1 | 当前页码。默认值为1。 |
StreamType | String | 否 | all | 流类型。取值:
|
QueryType | String | 否 | fuzzy | 指定是否模糊匹配流名称。取值:
|
OrderBy | String | 否 | publish_time_desc | 排序方式。取值:
|
返回数据
名称 |
类型 |
示例值 |
描述 |
TotalPage | Integer | 2 | 总页数。 |
PageNum | Integer | 2 | 分页的页码。 |
PageSize | Integer | 10 | 每页大小。 |
RequestId | String | 40A4F36D-A7CC-473A-88E7-154F92242566 | 请求ID。 |
TotalNum | Integer | 11 | 符合条件的总个数。 |
PublishInfo | Array of LiveStreamPublishInfo | 推流记录信息。 |
|
LiveStreamPublishInfo | |||
EdgeNodeAddr | String | 10.175.XX.XX | CDN上行节点IP。 |
PublishUrl | String | rtmp://demo.aliyundoc.com/liveApp****/liveStream**** | 推流完整URL地址。 |
StreamName | String | liveStream**** | 播流名称。 |
DomainName | String | example.com | 推流域名或主播流域名。 |
StopTime | String | 2015-12-02T03:11:19Z | 停止推流时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
TranscodeId | String | ld | 若有转码,返回转码模板ID。 |
PublishDomain | String | demo.aliyundoc.com | 推流域名。 |
AppName | String | liveApp**** | 播流所属应用名称。 |
PublishTime | String | 2015-12-02T03:05:53Z | 开始推流时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
PublishType | String | edge | 推流类型。取值:
|
Transcoded | String | yes | 是否是转码流。 |
ClientAddr | String | 10.175.XX.XX | 主播IP。 |
StreamUrl | String | http://example.com/liveApp****/liveStream****.flv | 播流的URL。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsPublishList
&DomainName=example.com
&EndTime=2017-12-22T08:00:00Z
&StartTime=2017-12-21T08:00:00Z
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveStreamsPublishListResponse>
<TotalNum>11</TotalNum>
<TotalPage>2</TotalPage>
<PageSize>10</PageSize>
<PageNum>2</PageNum>
<RequestId> 40A4F36D-A7CC-473A-88E7-154F92242566</RequestId>
<PublishInfo>
<LiveStreamPublishInfo>
<PublishUrl>rtmp://demo.aliyundoc.com/liveApp****/liveStream****</PublishUrl>
<ClientAddr>10.175.XX.XX</ClientAddr>
<StreamName>liveStream****</StreamName>
<TranscodeId>ld</TranscodeId>
<DomainName>example.com</DomainName>
<EdgeNodeAddr>10.175.XX.XX</EdgeNodeAddr>
<PublishDomain>demo.aliyundoc.com</PublishDomain>
<Transcoded>yes</Transcoded>
<PublishTime>2015-12-02T03:05:53Z</PublishTime>
<PublishType>edge</PublishType>
<StreamUrl>http://example.com/liveApp****/liveStream****.flv</StreamUrl>
<StopTime>2015-12-02T03:11:19Z</StopTime>
<AppName>liveApp****</AppName>
</LiveStreamPublishInfo>
</PublishInfo>
</DescribeLiveStreamsPublishListResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DescribeLiveStreamsPublishListResponse" : {
"TotalNum" : 11,
"TotalPage" : 2,
"PageSize" : 10,
"PageNum" : 2,
"RequestId" : "40A4F36D-A7CC-473A-88E7-154F92242566",
"PublishInfo" : {
"LiveStreamPublishInfo" : {
"PublishUrl" : "rtmp://demo.aliyundoc.com/liveApp****/liveStream****",
"ClientAddr" : "10.175.XX.XX",
"StreamName" : "liveStream****",
"TranscodeId" : "ld",
"DomainName" : "example.com",
"EdgeNodeAddr" : "10.175.XX.XX",
"PublishDomain" : "demo.aliyundoc.com",
"Transcoded" : "yes",
"PublishTime" : "2015-12-02T03:05:53Z",
"PublishType" : "edge",
"StreamUrl" : "http://example.com/liveApp****/liveStream****.flv",
"StopTime" : "2015-12-02T03:11:19Z",
"AppName" : "liveApp****"
}
}
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InvalidStartTime.Malformed | Specified parameter StartTime is not valid. | StartTime参数错误,请您确认该StartTime参数是否正确。 |
400 | InvalidEndTime.Malformed | Specified parameter EndTime is not valid. | 结束时间错误,请您确认结束时间是否正确。 |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 传入的StartTime参数不支持。 |
访问错误中心查看更多错误码。