StartCloudRecord - 开始云端录制任务

本接口用于开始云端录制任务。

接口说明

使用说明

本接口用于开始云端录制任务。

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Panesobject []

单元格设置。

SourceTypestring

单元格媒体类型。取值:

  • video:用户摄像头或者屏幕共享流(默认值)。
  • camera:摄像头流。
  • screen:共享屏幕流。
video
PaneIdinteger

布局 ID,从 0 开始。

0
StorageConfigobject

存储配置

SecretKeystring

secretKey

APb6qWYEzKtYxE***
Bucketstring

存储桶名称

test-bucket-for-recording
Regioninteger

存储地域。

RegionAliYun OSS
0CN_Hangzhou
1CN_Shanghai
2CN_Qingdao
3CN_Beijing
4CN_Zhangjiakou
5CN_Huhehaote
6CN_Shenzhen
7CN_Hongkong
8US_West_1
9US_East_1
10AP_Southeast_1
11AP_Southeast_2
12AP_Southeast_3
13AP_Southeast_5
14AP_Northeast_1
15AP_South_1
16EU_Central_1
17EU_West_1
18EU_East_1(ME_East_1)
19AP_Southeast_6
20CN_Heyuan
21CN_Guangzhou
22CN_Chengdu
23CN_Nanjing
24CN_Fuzhou
25CN_Wulanchabu
26CN_Northeast_2
27CN_Southeast_7
0
AccessKeystring

accessKey

LTAX***
Vendorinteger

存储平台。取值:

vendor对象存储产品备注
1AliYun OSS阿里云
1
AppIdstring

应用 ID,通过控制台创建和查询,仅支持传单个 ID。

eo85****
ChannelIdstring

已存在的频道 ID,仅支持传单个 ID。

testid
TemplateIdstring

模版 ID。

567
TaskIdstring

本次云端录制的任务 ID,仅支持传单个 ID。由大小写字母、数字、下划线、短划线(-)组成,最大 55 字节。

123

返回参数

名称类型描述示例值
object

result

TaskIdstring

本次云端录制的任务 ID。

123
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "TaskId": "123",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用