Controls recordings manually on demand. For example, you can call this operation to start or stop recording at a specific point in time.
Operation description
Usage notes
- If a live stream is being automatically or manually recorded, you can call this operation to stop recording the live stream.
- If a live stream is interrupted after you manually record it, the recording stops.
- If automatic recording is not configured for the live stream, ApsaraVideo Live does not automatically record the live stream after it is resumed.
QPS limit
You can call this operation up to 50 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:RealTimeRecordCommand | get | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Command | string | Yes | The action to be performed. Valid values:
Note
stop forcibly stops recording. By default, a recording is generated after 180 seconds. cancel_delay resets the latency for stream interruption from 180 seconds to 0 seconds. This means that a recording is generated immediately.
| start |
| DomainName | string | Yes | The main streaming domain. | example.com |
| AppName | string | Yes | The name of the application to which the live stream belongs. | liveApp**** |
| StreamName | string | Yes | The name of the live stream. | liveStream**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | MalformedParam | %s |
| 400 | MissingParam | %s |
| 400 | CodeConfigNotFound | %s |
| 409 | StreamNotFound | %s |
| 409 | TaskAlreadyStarted | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|