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

停止 CDN 录制

更新时间:2022-09-30 16:44

1 描述

调用本接口停止 CDN 录制。相关回调请参考 录制文件生成回调

2 接口原型

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

3 请求参数

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

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

  • Tencent:腾讯云。
  • Ws:网宿。

4 请求示例

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

5 响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。
Data
Object
响应数据。
Tencent
Array of Object
腾讯云返回内容(Vendor 为 Tencent 时返回)。
StreamName
String
流名称。
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",
                "RequestId":"d39548da-fbd4-4dce-8023-cfccd28a9963",
                "Code":"",
                "Message":""
            }
        ],
        "Ws":{//此 Key 仅对 Vendor 设置为 Ws 有效
            "call_time":"2022-05-26 11:46:06",
            "http_code":200,
            "list":[
                {
                    "http_code":200,
                    "id":"test",
                    "msg":"success",
                    "persistentId":"202009a378bae528409f87dbe20717415676",
                    "task":"mp4"
                }
            ],
            "msg":null,
            "trace_id":"10021988-6472-4b6d-9f9a-6b5a6d4b6551"
        }
    },
    "RequestId":"4315169065145771656"
}

7 返回码

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

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