CreateRecordTask

Recent Pages

最后更新时间：2021-09-14 10:23:05

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to create a recording task that starts and ends at specified times and records by using the configuration corresponding to a specified recording template ID.

Prerequisites

Recording files are stored on the VOD platform, so if you need to use the recording feature, you must first activate the VOD service.
After the recording files are stored, applicable fees (including storage fees and downstream playback traffic fees) are charged according to the VOD billing method. For details, see the corresponding document.

Precautions

An interruption will end the current recording and generate a recording file. The task will still be valid before the end time expires, and the stream will be recorded within this period as long as it is pushed, regardless of whether the push is interrupted or restarted multiple times.
Avoid creating recording tasks with overlapping time periods. If there are multiple tasks with overlapping time periods for the same stream, the system will start three recording tasks at most to avoid repeated recording.
The record of a created recording task will be retained for 3 months on the platform.
The current recording task management APIs (CreateRecordTask/StopRecordTask/DeleteRecordTask) are not compatible with the legacy APIs (CreateLiveRecord/StopLiveRecord/DeleteLiveRecord), and they cannot be used together.
Do not create recording tasks and push streams at the same time, or recording tasks might not take effect and be delayed. Wait at least 3 seconds between each action.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: CreateRecordTask.
Version	Yes	String	Common parameter. The value used for this API: 2018-08-01.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
StreamName	Yes	String	Stream name.
DomainName	Yes	String	Push domain name.
AppName	Yes	String	Push path.
EndTime	Yes	Integer	Recording end time in UNIX timestamp format. `EndTime` should be later than `StartTime` and the current time, and the duration between `EndTime` and `StartTime` is up to 24 hours.
StartTime	No	Integer	Recording start time in UNIX timestamp format. Leaving this parameter empty means starting recording now. `StartTime` cannot be later than the current time plus 6 days.
StreamType	No	Integer	Push type. Default value: 0. Valid values: 0: LVB push. 1: mixed stream, i.e., A + B = C mixed stream.
TemplateId	No	Integer	Recording template ID, which is the returned value of `CreateLiveRecordTemplate`. If this parameter is left empty or incorrect, the stream will be recorded in HLS format and retained permanently by default.
Extension	No	String	Extension field which is not defined now. It is empty by default.

3. Output Parameters

Parameter Name	Type	Description
TaskId	String	A globally unique task ID. If `TaskId` is returned, the recording task has been successfully created.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample

Input Example

https://live.tencentcloudapi.com/?Action=CreateRecordTask
&AppName=live
&DomainName=5000.live.push.com
&StreamName=livetest
&StartTime=1589889600
&EndTime=1589904000
&TemplateId=0
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "TaskId": "UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error.
InternalError.GetConfigError	Error getting the configuration.
InternalError.NetworkError	Internal network error.
InvalidParameter	Invalid parameter.
LimitExceeded.MaximumRunningTask	The current number of concurrent tasks exceeds the limit.
ResourceUnavailable.InvalidVodStatus	The VOD service has not been activated.
UnsupportedOperation	Unsupported operation.

Recent Pages