調用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參數不支持。 |
訪問錯誤中心查看更多錯誤碼。