Queries the list of created monitoring sessions.

Description

Create monitoring sessions before you call this operation to query the monitoring session list. Make sure that the parameter settings meet requirements.

QPS limit

You can call this operation up to 15 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveStreamMonitorList

The operation that you want to perform. Set the value to DescribeLiveStreamMonitorList.

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

The ID of a monitoring session.

Note To obtain the MonitorId value, call the CreateLiveStreamMonitor operation.
PageNum Integer No 2

The number of the page to return.

PageSize Integer No 10

The number of monitoring sessions to return on each page.

Status Integer No 1

The status of a monitoring session. Valid values:

  • 1: Monitoring
  • 0: Unmonitored
OrderRule Integer No 1

How monitoring sessions are sorted in the list. The default value is 0. Valid values:

  • 0: Monitoring sessions are sorted by status.
  • 1: Monitoring sessions are sorted by start time in descending order.
  • 2. Monitoring sessions are sorted by start time in ascending order.

Response parameters

Parameter Type Example Description
LiveStreamMonitorList Array of LiveStreamMonitorInfo

The list of monitoring sessions.

AudioFrom Integer 1

The audio source in the layout.

Domain String demo.aliyundoc.com

The output domain name.

InputList Array of InputConfig

The list of monitored input streams.

Index Integer 1

The index.

InputUrl String demo.aliyundoc.com

The URL of an input stream.

LayoutConfig Struct

The layout information.

FillMode String none

The fill type. Specify "none" for this parameter.

PositionNormalized List 0.1

The normalized value of the coordinates of a layer, in the format of [x,y].

For example, [0.1,0.1] indicates that the layer is horizontally offset by 10% and vertically offset by 10% towards the upper-left corner.

PositionRefer String topLeft

The reference position of a layer. Valid values:

  • topLeft
  • topRight
  • bottomLeft
  • bottomRight
SizeNormalized List 0.3

The normalized value of the size of a layer, in the format of [w,h].

For example, [0.2,0.3] indicates that the width of the layer is 20% of the screen width, and the height of the layer is 30% of the screen height.

LayoutId Integer 1

The layout ID, which must start from 1.

PlayConfig Struct

The playback configurations.

VolumeRate Float 0.50

The volume. Valid values: 0 to 1. The value is rounded down to two decimal places.

StreamName String monitorStream****

The display name of a monitored stream.

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

The ID of a monitoring session.

MonitorName String liveMonito****

The name of a monitoring session.

OutputTemplate String lp_ud

The output resolution template. Valid values:

  • lp_ld: low definition.
  • lp_sd: standard definition.
  • lp_hd: high definition.
  • lp_ud: ultra high definition.
OutputUrls Struct

The output URLs.

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

The output URL in the FLV format.

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

The output URL in the RTMP format.

Region String cn-shanghai

The region. Valid values:

  • cn-shanghai: China (Shanghai).
  • cn-beijng: China (Beijing).
  • ap-southeast-1: Singapore (Singapore).
StartTime String 2017-01-11T12:00:00Z

The time at which monitoring starts, in UTC.

Status Integer 1

The status of a monitoring session. Valid values:

  • 1: Monitoring
  • 0: Unmonitored
StopTime String 2017-01-11T12:00:00Z

The time at which monitoring stops, in UTC.

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

The ID of the request.

Total Integer 1

The quantity.

Examples

Sample request

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamMonitorList
&<Common request parameters>

Sample success responses

XML format 

<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 format 

null

Error codes

For a list of error codes, visit the API Error Center.