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

禁止 CDN 推流

更新时间:2022-12-07 17:08

1 描述

调用本接口禁止 CDN 推流,适用直推 CDN 场景。如需应用于转推 CDN 场景,请使用 停止旁路推流 接口。

首次使用本接口,需要联系 ZEGO 技术支持进行配置。

2 接口原型

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

3 请求参数

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

参数 类型 是否必选 描述
StreamId
String
流 ID。

4 请求示例

https://rtc-api.zego.im/?Action=ForbidCDNLiveStream
&StreamId=cdn00
&<公共请求参数>

5 响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。
Data
Array of Object
响应数据。
└ CdnType
String
CDN 类型。
  • ws:网宿。
  • aliyun:阿里云。
  • tencent:腾讯云。
└ CdnResult
String
CDN 处理结果。

6 响应示例

{
    "Code": 0,
    "Message": "success",
    "Data": [
        {
            "CdnType": "ws",
            "CdnResult": "success append purge tasks"
        }
    ],
    "RequestId": "4113829426153229963"
}

7 返回码

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

返回码 说明 处理建议
0 请求成功。 -
1 请求失败。 -
2 参数错误。 -
3 鉴权失败。 请检查鉴权参数是否正确。