RealTimeRecordCommand - 实时录制指令

按需完成手动录制。例如动态启动录制、动态停止录制。

接口说明

  • 请确保在使用该接口前,已充分了解直播录制的收费方式和价格。计费详情,请参见直播录制费用

  • 该接口前只能控制录制配置生效的直播流,需要先完成添加录制配置

  • 如果某条直播流正在录制(自动录制或手动录制启动),您可以调用此接口停止该直播流的录制;但如果在启动时调用该接口尝试启动录制,则会返回 TaskAlreadyStarted 错误,表示任务已启动。

  • 手动启动录制的直播流如果发生断流,即会停止录制。如果没有配置自动录制,重新推流后不会自动启动录制。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:RealTimeRecordCommand

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-shanghai

Command

string

操作行为。取值:

  • start:强制启动录制。

  • stop:强制暂停录制。断流延迟时间到达后,生成录制文件。

  • cancel_delay:重置断流延迟时间,完全停止录制。如果任务已停止,立即生成录制文件。

  • restart:强制重新开始录制。如果 restart 之前在录制,立即生成文件。

说明

stop 会强制暂停录制,默认等待 180 秒后生成录制文件。cancel_delay会将断流等待时间从默认 180 秒改为 0,即立刻生成录制文件。

start

DomainName

string

主播流域名。

example.com

AppName

string

播流所属应用名称。您可在流管理页面查看 AppName。

liveApp****

StreamName

string

播流名称。请确保 StreamName 正确,您可在流管理页面查看 StreamName。

说明

该接口仅支持单条流操作,不支持通配符。

liveStream****

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

错误码

HTTP status code

错误码

错误信息

描述

400 MalformedParam %s
400 MissingParam %s
400 CodeConfigNotFound %s
500 InternalError %s
409 StreamNotFound %s
409 TaskAlreadyStarted %s

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情