Submits a live stream recording job.
Operation description
You can call this operation to record live streams of ApsaraVideo Live or third-party Real-Time Messaging Protocol (RTMP) live streams. We recommend that you ingest a stream before you call this operation to submit a recording job. If no stream is pulled from the streaming URL, the job attempts to pull a stream for 3 minutes. If the attempt times out, the recording service stops.
Before you submit a recording job, you must prepare an Object Storage Service (OSS) or ApsaraVideo VOD bucket. We recommend that you use a storage address configured in Intelligent Media Services (IMS) to facilitate the management and processing of generated recording files.
If the preset recording template does not meet your requirements, you can create a custom recording template.
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 |
|---|---|---|---|---|
| ice:SubmitLiveRecordJob | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| NotifyUrl | string | No | The callback URL. | https://example.com/imsnotify |
| StreamInput | object | Yes | The URL of the live stream. | |
| Type | string | Yes | The type of the live stream URL. The value can only be rtmp. | rtmp |
| Url | string | No | The URL of the live stream. | rtmp://example.com/live/stream1 |
| RecordOutput | object | Yes | The storage address of the recording. | |
| Type | string | Yes | The type of the storage address. | oss |
| Bucket | string | No | The bucket name. | imsbucket1 |
| Endpoint | string | No | The endpoint of the storage service. | oss-cn-hangzhou.aliyuncs.com |
| TemplateId | string | Yes | The ID of the recording template. | 69e1f9fe-1e97-11ed-ba64-0c42a1b73d66 |
| Name | string | Yes | The name of the recording job. | live stream record 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "BEA98A0C-7870-15FE-B96F-8880BB600A2C",
"JobId": "ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66"
}Error codes
For a list of error codes, visit the Service error codes.