DescribeLiveStreamMonitorList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the list of created monitoring sessions.

Operation description

First, create a monitoring session. You can then call this operation to query the list of monitoring sessions. When you call this operation, ensure that the required parameters are configured.

QPS limit

This operation is limited to 15 queries per second (QPS) for each user. API calls that exceed this limit are throttled. This may affect your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveStreamMonitorList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
MonitorId	string	No	The ID of the monitoring session. Note Obtain the MonitorId value from the response parameters of the CreateLiveStreamMonitor operation. If you leave this parameter empty, the data of all monitoring sessions is returned.	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNum	integer	No	The page number.	2
PageSize	integer	No	The number of monitoring sessions to return on each page.	10
Status	integer	No	The status of the monitoring session. Valid values: 1: The session is being monitored. 0: The session is not being monitored.	1
OrderRule	integer	No	The order in which to sort the monitoring sessions. Valid values: 0: Default. The monitoring sessions are sorted by monitoring status in descending order (active sessions are listed first). The start time is not used for sorting. 1: The monitoring sessions are sorted by start time in descending order. 2: The monitoring sessions are sorted by start time in ascending order.	1

Response parameters

Parameter	Type	Description	Example
	object
Total	integer	The total number of monitoring sessions.	1
RequestId	string	The request ID.	2234baba-a586-46ea-8bd4-c8f7891abcdef
LiveStreamMonitorList	array<object>	The list of monitoring sessions.
	object
MonitorConfig	string	The settings for monitoring alert thresholds. The value is a JSON string that includes the following fields: fpsLowThres: the alert threshold for the video frame rate. This is a float. brHighThres: the alert threshold for the audio and video bitrate. This is a float. eofDurationThresSec: the alert threshold for the stream interruption duration. This is a float.	"{\"fpsLowThres\": 0.6,\"brLowThres\": 1.1,\"eofDurationThresSec\": 10}"
Status	integer	The status of the monitoring session. Valid values: 1: The session is being monitored. 0: The session is not being monitored.	1
MonitorId	string	The ID of the monitoring session.	445409ec-7eaa-461d-8f29-4bec2eb9****
Domain	string	The output domain name for monitoring.	demo.aliyundoc.com
CallbackUrl	string	The webhook address for monitoring alert notifications.	http://guide.aliyundoc.com/notify
AudioFrom	integer	The audio source in the layout.	1
DingTalkWebHookUrl	string	The URL of the DingTalk chatbot.	https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****
MonitorName	string	The name of the monitoring session.	liveMonito****
StopTime	string	The time when monitoring stops. The time is in UTC format.	2017-01-11T12:00:00Z
StartTime	string	The time when monitoring starts. The time is in UTC format.	2017-01-11T12:00:00Z
OutputTemplate	string	The template for the output resolution. Valid values: lp_ld: low definition lp_sd: standard definition lp_hd: high definition lp_ud: ultra-high definition	lp_ud
Region	string	The region. Valid values: cn-shanghai: China (Shanghai) cn-beijing: China (Beijing) ap-southeast-1: Singapore	cn-shanghai
InputList	array<object>	The list of input streams for monitoring.
	object
Index	integer	The index. This parameter is used by the frontend.	1
InputUrl	string	The URL of the input stream.	demo.aliyundoc.com
LayoutId	integer	The layout ID. The value must start from 1.	1
StreamName	string	The display name of the stream for monitoring.	monitorStream****
LayoutConfig	object	The layout information.
FillMode	string	The fill mode. For frontend development, set this parameter to none.	none
PositionRefer	string	The reference point for the element's position. Valid values: topLeft topRight bottomLeft bottomRight	topLeft
PositionNormalized	array	The normalized coordinates of the element's position, in the format of [x,y]. The default value is [0,0]. The values of x and y must be normalized.
	number	The position of the element's fill area, in the format of [x,y]. The values of x and y are normalized percentages. For example, [0.1,0.1] indicates a horizontal offset of 10% and a vertical offset of 10% from the top-left corner.	0.1
SizeNormalized	array	The normalized size of the element's fill area, in the format of [w,h].
	number	The size of the element's fill area, in the format of [w,h]. The values of w and h are normalized percentages. For example, [0.2,0.3] indicates a horizontal proportion of 20% and a vertical proportion of 30%.	0.3
PlayConfig	object	The playback configuration.
VolumeRate	number	The volume. The value must be between 0 and 1, inclusive, with up to two decimal places.	0.50
OutputUrls	object	The output URLs for monitoring.
FlvUrl	string	The output URL in FLV format.	http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv
RtmpUrl	string	The output URL in RTMP format.	rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****

Examples

Success response

JSON format

{
  "Total": 1,
  "RequestId": "2234baba-a586-46ea-8bd4-c8f7891abcdef",
  "LiveStreamMonitorList": [
    {
      "MonitorConfig": "\"{\\\"fpsLowThres\\\": 0.6,\\\"brLowThres\\\": 1.1,\\\"eofDurationThresSec\\\": 10}\"",
      "Status": 1,
      "MonitorId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "Domain": "demo.aliyundoc.com",
      "CallbackUrl": "http://guide.aliyundoc.com/notify",
      "AudioFrom": 1,
      "DingTalkWebHookUrl": "https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****",
      "MonitorName": "liveMonito****",
      "StopTime": "2017-01-11T12:00:00Z",
      "StartTime": "2017-01-11T12:00:00Z",
      "OutputTemplate": "lp_ud",
      "Region": "cn-shanghai",
      "InputList": [
        {
          "Index": 1,
          "InputUrl": "demo.aliyundoc.com",
          "LayoutId": 1,
          "StreamName": "monitorStream****",
          "LayoutConfig": {
            "FillMode": "none",
            "PositionRefer": "topLeft",
            "PositionNormalized": [
              0.1
            ],
            "SizeNormalized": [
              0.3
            ]
          },
          "PlayConfig": {
            "VolumeRate": 0.5
          }
        }
      ],
      "OutputUrls": {
        "FlvUrl": "http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv",
        "RtmpUrl": "rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****"
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s
401	IllegalOperation	%s
500	InternalError	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.