服务端 API v2
  • API概览
  • 快速开始
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 场景服务接口
  • 回调说明
  • 全局返回码
  • 使用 Postman 调试

开始 CDN 录制

更新时间:2022-12-09 10:54

1 描述

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

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

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

使用本接口之前需要明确录制参数,然后将录制参数同步给 ZEGO 技术支持进行配置,或前往 ZEGO 控制台 自助配置,详情请参考控制台的 服务配置 - CDN

2 接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=StartCDNRecrod
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

3 请求参数

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

参数 类型 是否必选 描述
StreamId[]
Array of String
流 ID 列表。
以同时录制 “cdn01” 和 “cdn02” 两个流为例,请求的参数为:StreamId[]=cdn01和StreamId[]=cdn02。
Vendor
String
CDN 厂商名。

  • Tencent:腾讯云。
  • Ws:网宿。
EndTime
String
录制任务结束时间,Unix 时间戳。设置时间必须大于当前时间,且不能超过从当前时刻开始 24 小时之内的时间。

此参数仅在 Vendor 为 “Tencent” 时才生效。

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
腾讯云返回内容(Vendor 为 Tencent 时返回)。
StreamName
String
流名称。
TaskId
String
任务 ID,全局唯一标识录制任务。
RequestId
String
唯一请求 ID,每次请求都会返回; 定位问题时需要提供该次请求的 RequestId。
Code
String
当前流的错误码,请参考 Message 信息处理,或联系 ZEGO 技术支持。
Message
String
当前流错误信息。
Ws
Object
网宿返回内容(Vendor 为 Ws 时返回)。
msg
String
操作结果提示语。
http_code
Number
业务操作状态。
trace_id
String
流水号。
call_time
String
发起请求时间。
list
Array of Object
请求任务的处理结果列表。
task
String
录制文件的格式。
id
String
流 ID。
http_code
Number
该任务的操作状态,请参考 msg 信息处理,或联系 ZEGO 技术支持。
msg
Object
该任务的操作结果提示语。
persistentId
String
该任务的文件标识。

6 响应示例

{
    "Code":0,
    "Message":"success",
    "Data":{
        "Tencent":[ //此 Key 仅对 Vendor 设置为 Tencent 有效
            {
                "StreamName":"cdn01",
                "TaskId":"UUpTbkZUQV5WQVxrRFtDUQIUB29FWwMeAxwALBxMAggNHxw7WRUWGBVeEzoTDl0CDEoFNgIESVpXQV9rRVRCXlVKWGlFV0daVENeaFdURVNY",
                "RequestId":"70628bcd-5652-4d5c-aa04-97956a4e771a",
                "Code":"",
                "Message":""
            }
        ],
        "Ws":{//此 Key 仅对 Vendor 设置为 Ws 有效
          "call_time": "2022-04-27 14:27:48",
          "http_code": 200,
          "list": [
              {
                  "http_code": 200,
                  "id": "vega_test",
                  "msg": "success",
                  "persistentId": "2020bc8b648883c64e7e81f03cf72b70b86f",
                  "task": "mp4"
              }
          ],
          "msg": null,
          "trace_id": "15ccf21b-f3c2-4ee3-aaad-d995393f80cd"
        }
    },
    "RequestId":"4191282558729715911"
}

7 返回码

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

返回码 说明 处理建议
0 请求成功。 -
2 输出参数错误。 -
3 未开通相关权限。 请联系 ZEGO 技术支持。
4 CDN 类型不匹配。 请检查参数。
5 配置错误。 请联系 ZEGO 技术支持。
6 请求过于频繁。 请稍后重试。
7 鉴权失败。 请检查鉴权参数是否正确。
1000 请求失败。 请联系 ZEGO 技术支持。