Queries the list of created monitoring sessions.
Operation description
Usage notes
Create monitoring sessions before you call this operation to query the monitoring session list. Make sure that the parameter settings meet the requirements.
QPS limit
You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:DescribeLiveStreamMonitorList | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MonitorId | string | No | The ID of the monitoring session. Note
You can obtain the monitoring session ID from the response of the CreateLiveStreamMonitor operation.
| 445409ec-7eaa-461d-8f29-4bec2eb9**** |
| PageNum | integer | No | The page number. | 2 |
| PageSize | integer | No | The number of monitoring sessions to return per page. | 10 |
| Status | integer | No | The status of the monitoring session. Valid values:
| 1 |
| OrderRule | integer | No | The sorting order of monitoring sessions. Valid values:
| 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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 |
For a list of error codes, visit the Service error codes.