Updates the configurations of a monitoring session.
Operation description
You can call this operation to update the configurations of a monitoring session. The updates that you make to the input source configurations when the monitoring session is in the Running state immediately take effect.
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.
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:UpdateLiveStreamMonitor | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| MonitorId | string | Yes | 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**** |
| MonitorName | string | No | The name of the monitoring session. | liveMonitor**** |
| Domain | string | No | The domain name. | demo.aliyundoc.com |
| App | string | No | The name of the application to which the output stream of the monitoring session belongs. 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. | monitorStream**** |
| OutputTemplate | string | No | The output template of the monitoring session. Valid values:
| lp_ud |
| InputList | string | Yes | The list of input streams to monitor. For more information, see the following InputConfig table. | InputConfig |
| MonitorConfig | string | No | The monitoring alert thresholds. The value is a JSON string. For more information, see the following MonitorConfig table. | "{\"fpsLowThres\": 0.6,\"brLowThres\": 1.1,\"eofDurationThresSec\": 10}" |
| CallbackUrl | string | No | The callback URL. Supported formats include HTTP and HTTPS. | http://guide.aliyundoc.com/notify |
| DingTalkWebHookUrl | string | No | The URL of the DingTalk chatbot. Specify a DingTalk chatbot that you have configured, and you can receive live monitoring alerts from the chatbot. For more information, see Configure a custom chatbot. Note
Specify "Alert" as the custom keyword of the DingTalk chatbot. Otherwise, you cannot receive messages.
| https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa**** |
InputConfig
| Field | Type | Description | Example |
|---|---|---|---|
| Index | Integer | The index. | 1 |
| LayoutId | Integer | The layout ID, which must start from 1. | 1 |
| StreamName | String | The display name of the stream to monitor. | monitorStream**** |
| InputUrl | String | The URL of the input stream. | demo.aliyundoc.com |
| LayoutConfig | LayoutConfig | The layout information. | See the following LayoutConfig table. |
| PlayConfig | PlayConfig | The playback configurations. | See the following PlayConfig table. |
LayoutConfig
| Field | Type | Description | Example |
|---|---|---|---|
| FillMode | String | The fill type. Set this value to none. | none |
| PositionRefer | String | The reference position of the element. Valid values: topLeft, topRight, bottomLeft, and bottomRight. | TopLeft |
| PositionNormalized | Float | The normalized value of the position of the layer, in the format of [x,y].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 of the size of the layer, in the format of [w,h].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
| Field | Type | Description | Example |
|---|---|---|---|
| VolumeRate | Float | The volume. Valid values: 0 to 1. The value is rounded to two decimal places. | 0.50 |
MonitorConfig
| Field | Type | Description | Example |
|---|---|---|---|
| fpsLowThres | Float | The video frame rate alert threshold. This threshold is a scale factor. Valid values: (0.0,1.0]. Default value: 0.7. When the video frame rate of the monitored stream is less than the threshold times the original frame rate of the stream, an alert is triggered. | 0.7 |
| brHighThres | Float | The audio/video bitrate alert threshold. This threshold is a scale factor. Valid values: (0.0,100]. Default value: 1.0. When the audio/video bitrate of the monitored stream is greater than the threshold times the original bitrate of the stream, an alert is triggered. | 1.0 |
| eofDurationThresSec | Float | The interruption duration alert threshold. If the monitored stream is interrupted for a period of time that is longer than the threshold, an alert is triggered. Valid values: (0,65535]. Default value: 0. Unit: seconds. - After the stream is interrupted, the connection is still available and a packet timeout occurs after 5 seconds. The system determines whether there is an interruption based on the timeout. If you set this parameter to a value that is less than or equal to 5 seconds, the threshold is fixed at 5 seconds. If you set this parameter to a value that is greater than 5 seconds, the threshold is the specified value. - If the stream is resumed within the threshold after it is interrupted, no alert is triggered. If you modify the URL of the monitored stream within the threshold after the stream is interrupted, interruption detection is not performed for the stream and no alert is triggered. | 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidUserId.Malformed | %s |
| 400 | InvalidParameter.Malformed | %s |
| 400 | MissingParameter | %s |
| 400 | InvalidMonitorId.Malformed | %s |
| 401 | IllegalOperation | %s |
| 404 | InvalidDomainName.NotFound | %s |
| 404 | StreamMonitorNotExist | %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 |