SubmitLiveRecordJob - - Alibaba Cloud Documentation Center

Operation description

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:SubmitLiveRecordJob

*All Resource

*

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. Valid values: rtmp : 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 elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	BEA98A0C-7870-15FE-B96F-8880BB600A2C
JobId	string	The ID of the recording job.	ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66

Examples

Success response

JSON format

{
  "RequestId": "BEA98A0C-7870-15FE-B96F-8880BB600A2C",
  "JobId": "ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.