查看指定域名下(或者指定域名下某个应用)的所有正在推的流的信息。

说明 查询推流在线列表接口的访问频率限制为每分钟1,000次,请您注意不要频繁调用,以免造成业务不可用。

请求参数

参数 类型 是否必选 示例值 描述
Action String DescribeLiveStreamsOnlineList 系统规定参数。取值:DescribeLiveStreamsOnlineList
DomainName String play.yourdomain.com 您的加速域名。
AppName String testApp 应用名称。
说明 AppName 不支持通配符(*)查询,且不支持模糊查询。
StreamName String livestream 流名称。
说明 StreamName不支持通配符(*)查询,但支持模糊查询 。
StreamType String all

流类型。取值范围:

  • all
  • raw
  • trans
对应查询所有流、原始流、转码流,默认all返回所有流信息。
QueryType String fuzzy 指定是否模糊匹配流名称。
取值:
  • fuzzy:模糊匹配
  • strict:精准匹配
StartTime String 2016-06-29T19:00:00Z 起始时间。
  • UTC格式
  • 例如:2016-06-29T19:00:00Z
EndTime String 2016-06-30T19:00:00Z 结束时间。
  • UTC格式
  • 例如:2016-06-30T19:00:00Z
  • EndTime和StartTime之间的间隔不能超过30天。
PageNum Integer 1 取得第几页,默认1。
PageSize Integer 1500

每页大小,最大3000。

取值:1~3000之前的任意整数。

默认值:2000

返回参数

名称 类型 示例值 描述
OnlineInfo 正在推送流的信息。
  └DomainName String play.yourdomain.com 流所属加速域名。
  └AppName String AppName 流所属应用名称。
  └StreamName String StreamName 流名称。
  └PublishTime String 2015-12-02T06:58:04Z 开始推流时刻 UTC 时间。
  └PublishUrl String rtmp://play.aliyunlive.com/AppName/StreamName 推流完整 URL 地址。
  └PublishDomain String push.aliyunlive.com 直播推流域名,使用中心推流的可直接填写播放域名。
RequestId String 40A4F36D-A7CC-473A-88E7-154F92242566 该条任务请求ID。
PageNum Integer 1 分页的页码。
PageSize Integer 10 每页显示的条数。
TotalNum Integer 10 符合条件的总个数。
TotalPage Integer 100 总页数。

示例

请求示例
https://live.aliyuncs.com/?Action=DescribeLiveStreamsOnlineList&DomainName=test101.aliyunlive.com&PageSize=10&PageNum=2&<公共请求参数> 
说明 关于公共请求参数详细内容,参见 公共请求参数

正常返回示例

JSON格式
{
    "OnlineInfo":{
        "LiveStreamOnlineInfo":[{
            "AppName":"xchen",
            "DomainName":"test101.cdnpe.com",
            "PublishTime":"2015-12-02T06:58:04Z",
            "PublishUrl":"rtmp://test101.cdnpe.com/xchen",
            "StreamName":"testxchen"
        }]
    },
    "PageNum":2,
    "PageSize":10,
    "RequestId":"0D70427D-91E4-4349-AAD3-5511A5BB823B",
    "TotalNum":11,
    "TotalPage":2
}

异常返回示例

JSON格式
{
    "Code":"InternalError",
    "HostId":"live.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

错误码

查看本产品错误码