You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/录制配置/创建直播录制任务
创建直播录制任务
最近更新时间：2024.08.05 14:03:59首次发布时间：2023.07.10 21:02:29
我的收藏

调用 CreatePullRecordTask 接口，创建一个在指定时间启动和结束的直播拉流录制任务，创建成功后，可以在直播过程中录制任意时长单路直播流并保存为视频文件。

使用说明

调用本接口，可以根据您配置的录制开始时间 StartTime 和结束时间 EndTime，对指定的拉流地址 StreamURL 进行录制，该任务的录制规则和与之关联的录制配置一致。录制任务和录制配置通过 Domain 和 App 参数关联，因此，直播录制任务的 Vhost、Domain 和 App 需要在录制配置的生效范围内。例如，您需要创建一个 "Vhost":"live.example.com"、"Domain":"live.example.push.com"、"App":"live" 的录制任务；则调用 CreateRecordPresetV2 添加录制配置时，Vhost 的取值应该为 live.example.com，App 的取值应该为 live 或 *。

注意事项

  • 使用限制：对于同一路流，上一个录制任务结束之后，才可以创建新的直播录制任务。
  • 断流规则：如果直播流断流超过 120s，则对应的直播录制任务会立即结束；如果未超过 120s，会根据录制配置中的规则，进行录制。
  • 请求频率：单用户请求频率限制为 50 次/秒。
  • 前提条件：为录制任务对应的 Vhost、Domain 和 App 添加录制配置。

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString否push.example.com域名空间。您可以调用 ListVhostRecordPresetV2 接口查看待使用的录制配置的 Vhost 取值。
DomainString是push.example.com直播流使用的推流域名或拉流域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的域名。
AppString是Live应用名称，即直播流地址的 AppName 字段取值，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
StreamString是example_stream流名称，即直播流地址的 StreamName 字段取值，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、字母、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。

StreamURL

String

是

http://example.push.com/Live/example_stream.flv

待录制直播流的拉流地址。

说明

当前仅支持 FLV 格式的拉流地址。

StartTimeString否2023-06-30T15:04:05+08:00指定录制任务的开始时间，RFC3339 格式的时间戳，精度为秒。默认为空，表示立即开始。
EndTimeString否2023-06-30T15:05:05+08:00指定录制任务的结束时间，RFC3339 格式的时间戳，精度为秒，默认为空，表示录制到直播流结束。

返回参数

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

参数类型示例值描述
TaskIdStringf831f3b0********1aa4dcf7621任务 ID，录制任务的唯一标识。

请求示例

POST https://live.volcengineapi.com?Action=CreatePullRecordTask&Version=2023-01-01
{
  "Domain": "push.example.com",
  "App": "Live",
  "Stream": "example_stream",
  "StreamURL": "http://pull.example.com/Live/example_stream.flv",
  "Vhost": "push.example.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"
  }
}

错误码

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

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

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。