获取某一时间段内某个域名(或域名下某应用或某个流)的历史推流记录。
接口说明
调用本接口最多可查询近 30 天的历史流。返回的数据为查询时间段内的在线流信息。本接口目前支持以下排序方式:
- 
stream_name_desc:按直播流名称倒序。
 - 
stream_name_asc:按直播流名称升序。
 - 
publish_time_desc:按推流时间倒序。
 - 
publish_time_asc:按推流时间升序。
 
QPS 限制
本接口的单用户 QPS 限制为 3 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
        
            调试
        
    
授权信息
| 
                                 操作  | 
                            
                                 访问级别  | 
                            
                                 资源类型  | 
                            
                                 条件关键字  | 
                            
                                 关联操作  | 
                        
| 
                                 live:DescribeLiveStreamsPublishList  | 
                            
                                 get  | 
                            
                                     *全部资源 
  | 
                            无 | 无 | 
请求参数
| 
                             名称  | 
                        
                             类型  | 
                        
                             必填  | 
                        
                             描述  | 
                        
                             示例值  | 
                    
| RegionId | 
                             string  | 
                        
                             否  | 
                        
                             地域 ID。  | 
                        
                             cn-shanghai  | 
                    
| DomainName | 
                             string  | 
                        
                             是  | 
                        
                             推流域名或主播流域名。 说明 
 
  | 
                        
                             example.com  | 
                    
| AppName | 
                             string  | 
                        
                             否  | 
                        
                             播流所属应用名称。您可在流管理页面查看 AppName。  | 
                        
                             liveApp****  | 
                    
| StreamName | 
                             string  | 
                        
                             否  | 
                        
                             播流名称。您可在流管理页面查看 StreamName。  | 
                        
                             liveStream****  | 
                    
| StartTime | 
                             string  | 
                        
                             是  | 
                        
                             推流时间。 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。  | 
                        
                             2017-12-21T08:00:00Z  | 
                    
| EndTime | 
                             string  | 
                        
                             是  | 
                        
                             结束时间。EndTime 和 StartTime 之间的间隔不能超过 30 天。 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。  | 
                        
                             2017-12-22T08:00:00Z  | 
                    
| PageSize | 
                             integer  | 
                        
                             否  | 
                        
                             分页大小。取值范围:1~3000,默认值为 2000。  | 
                        
                             1500  | 
                    
| PageNumber | 
                             integer  | 
                        
                             否  | 
                        
                             当前页码。默认值为 1。  | 
                        
                             1  | 
                    
| StreamType | 
                             string  | 
                        
                             否  | 
                        
                             流类型。取值: 
  | 
                        
                             all  | 
                    
| QueryType | 
                             string  | 
                        
                             否  | 
                        
                             指定是否模糊匹配流名称。取值: 
  | 
                        
                             fuzzy  | 
                    
| OrderBy | 
                             string  | 
                        
                             否  | 
                        
                             排序方式。取值: 
  | 
                        
                             publish_time_desc  | 
                    
返回参数
| 
                             名称  | 
                        
                             类型  | 
                        
                             描述  | 
                        
                             示例值  | 
                    
| 
                             object  | 
                        |||
| TotalPage | 
                             integer  | 
                        
                             总页数。  | 
                        
                             2  | 
                    
| PageNum | 
                             integer  | 
                        
                             分页的页码。  | 
                        
                             2  | 
                    
| PageSize | 
                             integer  | 
                        
                             每页大小。  | 
                        
                             10  | 
                    
| RequestId | 
                             string  | 
                        
                             请求 ID。  | 
                        
                             40A4F36D-A7CC-473A-88E7-154F92242566  | 
                    
| TotalNum | 
                             integer  | 
                        
                             符合条件的总个数。  | 
                        
                             11  | 
                    
| PublishInfo | 
                             object  | 
                        ||
| LiveStreamPublishInfo | 
                             array<object>  | 
                        
                             推流记录信息。  | 
                        |
| 
                             object  | 
                        |||
| EdgeNodeAddr | 
                             string  | 
                        
                             CDN 上行节点 IP。  | 
                        
                             10.175.XX.XX  | 
                    
| PublishUrl | 
                             string  | 
                        
                             推流完整 URL 地址。  | 
                        
                             rtmp://demo.aliyundoc.com/liveApp****/liveStream****  | 
                    
| StreamName | 
                             string  | 
                        
                             播流名称。  | 
                        
                             liveStream****  | 
                    
| DomainName | 
                             string  | 
                        
                             推流域名或主播流域名。  | 
                        
                             example.com  | 
                    
| StopTime | 
                             string  | 
                        
                             停止推流时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。  | 
                        
                             2015-12-02T03:11:19Z  | 
                    
| TranscodeId | 
                             string  | 
                        
                             转码模板 ID。 说明 
 当 Transcoded 参数为 no 时,不返回此参数。  | 
                        
                             ld  | 
                    
| PublishDomain | 
                             string  | 
                        
                             推流域名。  | 
                        
                             demo.aliyundoc.com  | 
                    
| AppName | 
                             string  | 
                        
                             播流所属应用名称。  | 
                        
                             liveApp****  | 
                    
| PublishTime | 
                             string  | 
                        
                             开始推流时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。  | 
                        
                             2015-12-02T03:05:53Z  | 
                    
| PublishType | 
                             string  | 
                        
                             推流类型。取值: 
  | 
                        
                             edge  | 
                    
| Transcoded | 
                             string  | 
                        
                             是否是转码流。  | 
                        
                             yes  | 
                    
| ClientAddr | 
                             string  | 
                        
                             主播 IP。  | 
                        
                             10.175.XX.XX  | 
                    
| StreamUrl | 
                             string  | 
                        
                             播流的 URL。  | 
                        
                             http://example.com/liveApp****/liveStream****.flv  | 
                    
| AliInnerErrorFlags | 
                             string  | 
                        
                             断流原因错误码。格式为:3 个数字或 1 个数字。  | 
                        
                             002  | 
                    
示例
正常返回示例
JSON格式
{
  "TotalPage": 2,
  "PageNum": 2,
  "PageSize": 10,
  "RequestId": " 40A4F36D-A7CC-473A-88E7-154F92242566",
  "TotalNum": 11,
  "PublishInfo": {
    "LiveStreamPublishInfo": [
      {
        "EdgeNodeAddr": "10.175.XX.XX",
        "PublishUrl": "rtmp://demo.aliyundoc.com/liveApp****/liveStream****",
        "StreamName": "liveStream****",
        "DomainName": "example.com",
        "StopTime": "2015-12-02T03:11:19Z",
        "TranscodeId": "ld",
        "PublishDomain": "demo.aliyundoc.com",
        "AppName": "liveApp****",
        "PublishTime": "2015-12-02T03:05:53Z",
        "PublishType": "edge",
        "Transcoded": "yes",
        "ClientAddr": "10.175.XX.XX",
        "StreamUrl": "http://example.com/liveApp****/liveStream****.flv",
        "AliInnerErrorFlags": "002"
      }
    ]
  }
}
            错误码
| 
                                 HTTP status code  | 
            				
                                 错误码  | 
            				
                                 错误信息  | 
            				
                                 描述  | 
            			
|---|---|---|---|
| 400 | QpsOverLimit | Qps is over limit for this domainName. | |
| 400 | InvalidStartTime.Malformed | Specified parameter StartTime is not valid. | |
| 400 | InvalidEndTime.Malformed | Specified parameter EndTime is not valid. | |
| 400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 传入的StartTime参数不支持。 | 
| 400 | InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | |
| 400 | Duration.Exceed | Duration between StartTime and EndTime is too long. | |
| 400 | LiveServiceNotFound | Your account does not open Live service yet | 您的账户尚未开通直播服务 | 
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。