文档中心

创建直播录制任务

最近更新时间：2023.10.23 16:13:58

首次发布时间：2023.07.10 21:02:29

本接口支持创建直播录制任务，创建成功后，可以将实时的视频直播流进行录制（Record）并保存为视频文件。

注意事项

请求频率：单用户请求频率限制为 50 次/秒。
前提条件：创建录制任务需使用与指定域名空间下的 App 绑定的录制模版，未绑定录制模板会发生报错，调用本接口创建直播录制任务之前，请联系技术支持配置录制模版。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=CreatePullRecordTask&Version=2023-01-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreatePullRecordTask`	接口名称。当前 API 的名称为 `CreatePullRecordTask`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
Vhost	String	否	`live.example.push.com`	域名空间名称。
Domain	String	是	`live.example.push.com`	拉流/推流域名。
App	String	是	`Live`	应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
Stream	String	是	`livestream001`	流名称，由 1 到 100 位数字、字母、下划线及"-"和"."组成。
StreamURL	String	是	`http://live.example.pull.com/Live/livestream001.flv`	拉流地址。
StartTime	String	否	`2023-06-30T15:04:05+08:00`	录制的开始时间，RFC3339 格式表示的 UTC 时间戳，精度为 s。
EndTime	String	否	`2023-06-30T15:05:05+08:00`	录制的结束时间，RFC3339 格式表示的 UTC 时间戳，精度为 s。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
TaskId	String	`f831f3b0********1aa4dcf7621`	任务 ID，任务的唯一标识。

示例

请求示例

POST https://live.volcengineapi.com?Action=CreatePullRecordTask&Version=2023-01-01
{
  "Domain": "live.example.push.com",
  "App": "Live",
  "Stream": "livestream001",
  "StreamURL": "http://live.example.pull.com/Live/livestream001.flv",
  "Vhost": "live.example.push.com",
  "StartTime": "2023-06-30T15:04:05+08:00",
  "EndTime": "2023-06-30T15:05:05+08:00"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "CreatePullRecordTask",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "TaskId": "f831f3b0********1aa4dcf7621"
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
429	RequestLimitExceeded	-	请求创建的资源（域名空间、域名、应用、配置模版、证书）超出限制。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。