调用DescribeLiveStreamMonitorList查询已创建的监播室列表。

使用说明

创建监播室后再调用本接口查询监播室列表,调用时请保证参数设置符合要求。

QPS限制

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

调试

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

请求参数

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

系统规定参数,取值:DescribeLiveStreamMonitorList

MonitorId String 445409ec-7eaa-461d-8f29-4bec2eb9****

监播室ID。

说明 通过查看CreateLiveStreamMonitor接口的返回参数获取MonitorId值。
PageNum Integer 2

当前页数值。

PageSize Integer 10

每页监播室数值个数。

Status Integer 1

监播室内状态。取值:

  • 1:监播中。
  • 0:未监播。
OrderRule Integer 1

启动时间顺序。取值:

  • 0:默认(按启动状态倒叙,启动时间不参与排序)。
  • 1:启动时间倒序。
  • 2:启动时间正序。

返回数据

名称 类型 示例值 描述
LiveStreamMonitorList Array of LiveStreamMonitorInfo

监播室列表。

AudioFrom Integer 1

布局声音来源。

Domain String demo.aliyundoc.com

监播输出域名。

InputList Array of InputConfig

监控流输入列表。

Index Integer 1

索引,前端使用。

InputUrl String demo.aliyundoc.com

输入流地址。

LayoutConfig Struct

布局信息。

FillMode String none

填充类型,前端填none即可。

PositionNormalized List 0.1

表示该Layer元素填充区位置[x,y],x和y归一化百分比。

例如[0.1,0.1]代表左上角水平偏移10%, 垂直偏移10%。

PositionRefer String topLeft

设置元素的position参考坐标值,取值:

  • topLeft
  • topRight
  • bottomLeft
  • bottomRight
SizeNormalized List 0.3

Layer元素需要填充的尺寸大小[w,h],w和h归一化百分比。

例如[0.2,0.3]代表水平占比20%,垂直占比30%。

LayoutId Integer 1

布局ID,必须从1开始。

PlayConfig Struct

播放配置。

VolumeRate Float 0.50

音量。取值0~1之间,精确小数点后2位。

StreamName String monitorStream****

监播流的显示名称。

MonitorId String 445409ec-7eaa-461d-8f29-4bec2eb9****

监播室ID。

MonitorName String liveMonito****

监播室名称。

OutputTemplate String lp_ud

监播输出分辨率模板。类型取值:

  • lp_ld:流畅。
  • lp_sd:标清。
  • lp_hd:高清。
  • lp_ud:超清。
OutputUrls Struct

监播输出地址。

FlvUrl String http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv

FLV输出地址。

RtmpUrl String rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****

RTMP输出地址。

Region String cn-shanghai

地区。取值:

  • cn-shanghai:上海。
  • cn-beijng:北京。
  • ap-southeast-1:新加坡。
StartTime String 2017-01-11T12:00:00Z

开始监播时间,UTC格式。

Status Integer 1

监播室内状态。取值:

  • 1:监播中。
  • 0:未监播。
StopTime String 2017-01-11T12:00:00Z

停止监播时间,UTC格式。

RequestId String 2234baba-a586-46ea-8bd4-c8f7891abcdef

请求ID。

Total Integer 1

数量。

示例

请求示例

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

正常返回示例

XML格式

<DescribeLiveStreamMonitorListResponse>
  <RequestId>2234baba-a586-46ea-8bd4-c8f7891abcdef</RequestId>
  <Total>1</Total>
  <LiveStreamMonitorList>
        <Status>1</Status>
        <AudioFrom>1</AudioFrom>
        <OutputTemplate>lp_ud</OutputTemplate>
        <StartTime>2017-01-11T12:00:00Z</StartTime>
        <MonitorName>liveMonito****</MonitorName>
        <Region>cn-shanghai</Region>
        <Domain>demo.aliyundoc.com</Domain>
        <MonitorId>445409ec-7eaa-461d-8f29-4bec2eb9****</MonitorId>
        <StopTime>2017-01-11T12:00:00Z</StopTime>
        <InputList>
              <StreamName>monitorStream****</StreamName>
              <LayoutId>1</LayoutId>
              <Index>1</Index>
              <InputUrl>demo.aliyundoc.com</InputUrl>
              <LayoutConfig>
                    <FillMode>none</FillMode>
                    <PositionRefer>topLeft</PositionRefer>
                    <PositionNormalized>0.1</PositionNormalized>
                    <SizeNormalized>0.3</SizeNormalized>
              </LayoutConfig>
              <PlayConfig>
                    <VolumeRate>0.50</VolumeRate>
              </PlayConfig>
        </InputList>
        <OutputUrls>
              <FlvUrl>http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv</FlvUrl>
              <RtmpUrl>rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****</RtmpUrl>
        </OutputUrls>
  </LiveStreamMonitorList>
</DescribeLiveStreamMonitorListResponse>

JSON格式

{"RequestId":"2234baba-a586-46ea-8bd4-c8f7891abcdef","Total":"1","LiveStreamMonitorList":[{"Status":"1","AudioFrom":"1","OutputTemplate":"lp_ud","StartTime":"2017-01-11T12:00:00Z","MonitorName":"liveMonito****","Region":"cn-shanghai","Domain":"demo.aliyundoc.com","MonitorId":"445409ec-7eaa-461d-8f29-4bec2eb9****","StopTime":"2017-01-11T12:00:00Z","InputList":[{"StreamName":"monitorStream****","LayoutId":"1","Index":"1","InputUrl":"demo.aliyundoc.com","LayoutConfig":{"FillMode":"none","PositionRefer":"topLeft","PositionNormalized":"0.1","SizeNormalized":"0.3"},"PlayConfig":{"VolumeRate":"0.50"}}],"OutputUrls":{"FlvUrl":"http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv","RtmpUrl":"rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****"}}]}

错误码

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