Creates a monitoring session.
Operation description
You can call this operation to create a monitoring session. Make sure that the parameter settings meet the requirements.
QPS limit
You can call this operation up to 10 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:CreateLiveStreamMonitor | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MonitorName | string | Yes | The name of the monitoring session. | liveMonitor**** |
| OutputTemplate | string | Yes | The output template of the monitoring session. Valid values:
| lp_ud |
| Domain | string | Yes | The endpoint of the monitoring session. | demo.aliyundoc.com |
| App | string | No | The name of the application that plays the output streams of the monitoring session. You can specify a name. If you do not specify a name, the system uses monitor as the name of the application. | monitor**** |
| Stream | string | No | The name of the output stream of the monitoring session. If you do not specify a name, the system generates a name at random. | monitorStream**** |
| InputList | string | Yes | The list of monitored input streams. For more information, see the following table InputConfig. | InputConfig |
| MonitorConfig | string | No | Alarm threshold setting for monitoring, in JSON format. For more details, please refer to the table below for MonitorConfig. | "{\"fpsLowThres\": 0.6,\"brLowThres\": 1.1,\"eofDurationThresSec\": 10}" |
| CallbackUrl | string | No | Supports input of callback addresses in HTTP(S) format. | http://guide.aliyundoc.com/notify |
| DingTalkWebHookUrl | string | No | DingTalk alert monitoring sends alert notifications through a DingTalk group robot. Please set up the DingTalk group robot first and enter the HTTP(S) address of the robot here. For more details, see Custom Robot Access. Note
Configure the custom keyword for the DingTalk group robot as 'alert', otherwise, messages will not be received.
| https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa**** |
InputConfig| Parameter | Type | Description | Example | | --------- | ---- | ----------- | ------- | | Index | Integer | The index. | 1 | | LayoutId | Integer | The ID of the layout. The value starts from 1. | 1 | | StreamName | String | The display name of a monitored stream. | monitorStream**** | | InputUrl | String | The URL of an input stream. | demo.aliyundoc.com | | LayoutConfig | LayoutConfig | The details of the layout. | For more information, see the following table LayoutConfig. | | PlayConfig | PlayConfig | The playback configurations. | For more information, see the following table PlayConfig. | LayoutConfig| Parameter | Type | Description | Example | | --------- | ---- | ----------- | ------- | | FillMode | String | The fill type. Set this value to none. | none | | PositionRefer | String | The reference coordinate value of an element position. Valid values: topLeft (upper left), topRight (upper right), bottomLeft (lower left), and bottomRight (lower right). | topLeft | | PositionNormalized | Float | The normalized value [x,y] of the coordinates of the layer.
The values of x and y range from 0 to 1.
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. | [0.1, 0.1] | | SizeNormalized | Float | The normalized value [w,h] of the size of the layer.
The values of w and h range from 0 to 1.
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. | [0.2, 0.3] | PlayConfig| Parameter | Type | Description | Example | | --------- | ---- | ----------- | ------- | | VolumeRate | Float | The volume. The value ranges from 0 to 1 and rounded down to two decimal places. | 0.50 |
Response parameters
Examples
Sample success responses
JSONformat
{
"MonitorId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidParameter.Malformed | %s |
| 400 | InvalidUserId.Malformed | %s |
| 400 | MissingParameter | %s |
| 400 | StreamMonitorExist | %s |
| 401 | IllegalOperation | %s |
| 404 | InvalidDomainName.NotFound | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-04 | The Error code has changed | View Change Details |