调用DescribeLiveStreamsOnlineList查询指定域名或者指定域名下某个应用的所有在线流信息。

说明 调用频率限制15次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLiveStreamsOnlineList

系统规定参数。取值:DescribeLiveStreamsOnlineList

DomainName String www.yourdomain.com

主播流域名。

RegionId String cn-shanghai

域名所属地域。

说明 由于视频直播的endpoint是区域化的。在SDK中的getProfile里,Regionid是必填项。
AppName String testApp

播流所属应用名称。

StreamName String myStream

播流名称。

PageSize Integer 1500

每页大小。取值范围:1~3000,默认值为2000

PageNum Integer 1

当前页码。默认值为1

StreamType String all

流类型。取值:

  • all(默认值):查询所有流。
  • raw:查询原始流。
  • trans:查询转码流。
QueryType String fuzzy

指定是否模糊匹配流名称。取值:

  • fuzzy(默认值):模糊匹配。
  • strict:精准匹配。

返回数据

名称 类型 示例值 描述
OnlineInfo Array of LiveStreamOnlineInfo

正在推送流的信息。

LiveStreamOnlineInfo
DomainName String www.yourdomain.com

主播流域名。

AppName String testApp

播流所属应用名称。

StreamName String StreamName

播流名称。

PublishTime String 2015-12-02T06:58:04Z

开始推流时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

PublishUrl String rtmp://play.aliyunlive.com/AppName/StreamName

推流完整URL地址。

PublishDomain String push.aliyunlive.com

推流域名。使用中心推流的可直接填写播流域名。

PageNum Integer 1

分页的页码。

PageSize Integer 10

每页显示的条数。

RequestId String 40A4F36D-A7CC-473A-88E7-154F92242566

请求ID。

TotalNum Integer 10

符合条件的总个数。

TotalPage Integer 100

总页数。

示例

请求示例

http(s)://live.aliyuncs.com?Action=DescribeLiveStreamsOnlineList
&DomainName=play.yourdomain.com
&<公共请求参数>

正常返回示例

XML格式

<DescribeLiveStreamsOnlineListResponse>
	  <OnlineInfo>
		    <LiveStreamOnlineInfo>
			      <AppName>testApp</AppName>
			      <DomainName>test101.cdnpe.com</DomainName>
			      <PublishTime>2015-12-02T06:58:04Z</PublishTime>
			      <PublishUrl>rtmp://test101.cdnpe.com/xchen</PublishUrl>
			      <StreamName>testxchen</StreamName>
		    </LiveStreamOnlineInfo>
	  </OnlineInfo>
	  <PageNum>2</PageNum>
	  <PageSize>10</PageSize>
	  <RequestId>0D70427D-91E4-4349-AAD3-5511A5BB823B</RequestId>
	  <TotalNum>11</TotalNum>
	  <TotalPage>2</TotalPage>
</DescribeLiveStreamsOnlineListResponse>

JSON格式

{
    "OnlineInfo":{
        "LiveStreamOnlineInfo":[{
            "AppName":"testApp",
            "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
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidStartTime.Malformed Specified StartTime is malformed. StartTime参数错误,请您确认该StartTime参数是否正确。
400 InvalidEndTime.Malformed Specified EndTime is malformed. 结束时间错误,请您确认结束时间是否正确。

访问错误中心查看更多错误码。