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

使用说明

本接口目前支持以下几种流类型:

  • all:查询所有流。
  • raw:查询原始流。
  • trans:查询转码流。

QPS限制

本接口的单用户QPS限制为10000次/分钟。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

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

系统规定参数。取值:DescribeLiveStreamsOnlineList

DomainName String example.com

主播流域名。

AppName String liveApp****

播流所属应用名称。

StreamName String liveStream****

播流名称。

OnlyStream String no

是否只返回指定字段。取值:

  • yes:结果只返回DomainName,AppName,StreamName,PublishTime 字段。
  • no:结果返回全部字段。
PageSize Integer 1500

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

PageNum Integer 1

当前页码。默认值为1。

StreamType String all

流类型。取值:

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

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

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

返回数据

名称 类型 示例值 描述
TotalPage Integer 2

总页数。

PageNum Integer 1

分页的页码。

PageSize Integer 10

每页显示的条数。

RequestId String 5c6a2a0df228-4a64- af62-20e91b9676b3

请求ID。

TotalNum Integer 11

符合条件的总个数。

OnlineInfo Array of LiveStreamOnlineInfo

正在推送流的信息。

LiveStreamOnlineInfo
FrameRate Integer 15

帧率。

PublishUrl String rtmp://demo.aliyundoc.com/live/test****

推流完整URL地址。

StreamName String liveStream****

播流名称。

AudioCodecId Integer 10

音频Codec ID。

Height Integer 720

视频分辨率高度。

DomainName String example.com

主播流域名。

PublishDomain String demo.aliyundoc.com

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

PublishTime String 2021-08-09T02:37:59Z

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

AppName String liveApp****

播流所属应用名称。

PublishType String edge

推流类型,取值:

  • edge:边缘推流。
  • center:中心推流。
VideoCodecId Integer 7

视频Codec ID。

Transcoded String no

是否是转码流。取值:

  • yes:是。
  • no:否。
Width Integer 1280

视频分辨率宽度。

ClientIp String 106.11.XX.XX

推流客户端IP。

ServerIp String 120.221.XX.XX

推流节点IP。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsOnlineList
&DomainName=example.com
&AppName=liveApp****
&StreamName=liveStream****
&OnlyStream=no
&PageSize=1500
&PageNum=1
&StreamType=all
&QueryType=fuzzy
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamsOnlineListResponse>
    <TotalPage>2</TotalPage>
    <PageNum>1</PageNum>
    <PageSize>10</PageSize>
    <RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>
    <TotalNum>11</TotalNum>
    <OnlineInfo>
        <FrameRate>15</FrameRate>
        <PublishUrl>rtmp://demo.aliyundoc.com/live/test****</PublishUrl>
        <StreamName>liveStream****</StreamName>
        <AudioCodecId>10</AudioCodecId>
        <Height>720</Height>
        <DomainName>example.com</DomainName>
        <PublishDomain>demo.aliyundoc.com</PublishDomain>
        <PublishTime>2021-08-09T02:37:59Z</PublishTime>
        <AppName>liveApp****</AppName>
        <PublishType>edge</PublishType>
        <VideoCodecId>7</VideoCodecId>
        <Transcoded>no</Transcoded>
        <Width>1280</Width>
        <ClientIp>106.11.XX.XX</ClientIp>
        <ServerIp>120.221.XX.XX</ServerIp>
    </OnlineInfo>
</DescribeLiveStreamsOnlineListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalPage" : 2,
  "PageNum" : 1,
  "PageSize" : 10,
  "RequestId" : "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "TotalNum" : 11,
  "OnlineInfo" : [ {
    "FrameRate" : 15,
    "PublishUrl" : "rtmp://demo.aliyundoc.com/live/test****",
    "StreamName" : "liveStream****",
    "AudioCodecId" : 10,
    "Height" : 720,
    "DomainName" : "example.com",
    "PublishDomain" : "demo.aliyundoc.com",
    "PublishTime" : "2021-08-09T02:37:59Z",
    "AppName" : "liveApp****",
    "PublishType" : "edge",
    "VideoCodecId" : 7,
    "Transcoded" : "no",
    "Width" : 1280,
    "ClientIp" : "106.11.XX.XX",
    "ServerIp" : "120.221.XX.XX"
  } ]
}

错误码

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

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