接口说明

使用说明

调用本接口前，您必须已经调用 AddRecordTemplate 添加录制配置模板。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作
暂无数据

请求参数

字段名称	字段详情
LayoutIdsarray<integer<int64>>	布局 ID 组。示例值:1111子级条数 <= 64
Formatsarray<string>	录制文件格式。示例值:mp4子级条数 <= 3
Backgroundsarray<object>	背景图片信息。子级条数 <= 1
Watermarksarray<object>	水印信息。子级条数 <= 1
ClockWidgetsarray<object>	时钟信息。子级条数 <= 1
AppIdstring	应用 ID。通过控制台创建和查询，仅支持传单个 ID。示例值:yourAppId
Namestring	录制配置模板名称。示例值:录制模板
TemplateIdstring	配置模板 ID。获取模板 ID，请参加 AddRecordTemplate 。示例值:76dasgb****参考取值来源: AddRecordTemplate CreateAppRecordTemplate DescribeRecordTemplates ModifyAppStreamingOutTemplate
TaskProfilestring	任务计费配置。示例值:4IN_1080P
MediaEncodeinteger<int32>	编码选项。示例值:20
BackgroundColorinteger<int32>	背景色 RGB，默认是 0（黑色）。计算公式为 R+G×256+B×65536，R（红）、G（绿）、B（蓝）的取值：0~255。示例值:0
OssBucketstring	录制文件存储的 OSS Bucket。示例值:rtc-record-pre
OssFilePrefixstring	录制文件命名规则。示例值:record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}
MnsQueuestring	录制事件回调消息队列。示例值:record-callback-queue
HttpCallbackUrlstring	录制事件 HTTP 回调地址。示例值:http://example.com/callback
FileSplitIntervalinteger<int32>	录制文件切割时长（大于等于 1800）。单位：秒。示例值:1800
DelayStopTimeinteger<int32>	延时停止录制的时间。单位：秒。默认值为 180 秒。示例值:180取值 <= 86400
EnableM3u8DateTimeboolean	录制的 m3u8 文件是否需要加上 ts 文件时间点。示例值:false
OssEndpointstring

返回参数

字段名称	字段详情
TemplateIdstring	录制配置模板 ID。示例值:76dasgb****
RequestIdstring	该条任务请求 ID。示例值:760bad53276431c499e30dc36f6b26be

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

200	TaskExisted	the task is existed	诊断

变更历史

	变更时间	变更内容概要	操作
	2022-06-21	新增请求参数OssEndpoint

UpdateRecordTemplate_音视频通信_API文档