服务端 API v2

开始 CDN 录制

更新时间:2021-06-29 14:45

1 描述

CDN 可配置是否对所有直播流录制,若需要选择录制某条具体的直播流,可调用本接口实现。相关回调请参考 录制文件生成回调

在使用腾讯云提供的 CDN 服务时,要明确以下录制参数:

  • 录制文件格式:支持 M3U8、FLV、MP4、AAC(单音频)和 MP3(单音频)。
  • 录制间隔:录制文件的时长,单位为秒 (s),取值范围为 300 s ~ 7200 s,默认值为 7200 s。此参数对 M3U8 录制文件格式无效。如果希望录制文件的时长超过 7200 s(2 小时),则需要使用录制文件合并接口对多个录制文件进行合并。
  • 存储时长:明确录制文件的保留时长。

调用频率限制:

  • 正式环境:20 次/秒。
  • 测试环境:20 次/秒。

使用本接口之前需要明确录制参数,然后将录制参数同步给 ZEGO 技术支持并申请开通。

2 接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=StartCDNRecrod
  • 传输协议:HTTPS

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

参数 类型 是否必选 描述
StreamId[] Array of String 流 ID 列表。
以同时录制 “cdn01” 和 “cdn02” 两个流为例,请求的参数为:StreamId[]=cdn01和StreamId[]=cdn02。
Vendor String CDN 厂商名。
  • Tencent:腾讯云。
EndTime String 录制任务结束时间,Unix 时间戳。设置时间必须大于当前时间,且不能超过从当前时刻开始 24 小时之内的时间。

4 请求示例

https://rtc-api.zego.im/?Action=StartCDNRecrod
&StreamId[]=cdn01
&StreamId[]=cdn02
&Vendor=Tencent
&EndTime=1616415377
&<公共请求参数>

5 响应参数

参数 类型 描述
Code Number 返回码。
Message String 操作结果描述。
RequestId String 请求 ID。
Data Object 响应数据。
└ Tencent Array of Object 腾讯云返回内容(CDN 为腾讯云时返回)。
  └ StreamName String 流名称。
  └ TaskId String 任务 ID,全局唯一标识录制任务。
  └ RequestId String 唯一请求 ID,每次请求都会返回; 定位问题时需要提供该次请求的 RequestId。
  └ Code String 当前流的错误码。
  └ Message String 当前流错误信息。

6 响应示例

{
    "Code":0,
    "Message":"success",
    "Data":{
        "Tencent":[
            {
                "StreamName":"cdn01",
                "TaskId":"UUpTbkZUQV5WQVxrRFtDUQIUB29FWwMeAxwALBxMAggNHxw7WRUWGBVeEzoTDl0CDEoFNgIESVpXQV9rRVRCXlVKWGlFV0daVENeaFdURVNY",
                "RequestId":"70628bcd-5652-4d5c-aa04-97956a4e771a",
                "Code":"",
                "Message":""
            }
        ]
    },
    "RequestId":"4191282558729715911"
}

7 返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码 说明
41001 直播保存失败。
41002 频道保存失败。
41003 直播不存在。
41004 流已不存在。
42001 禁用直播失败。
42002 恢复直播失败。
43001 创建录制索引文件失败。