logo
实时语音
服务端 API
当前页

禁止 CDN 推流


描述

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

注意

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

接口原型

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

请求参数

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

参数类型是否必选描述
StreamIdString流 ID。
ResumeTimeString恢复流的时间。UTC 格式,例如:2018-11-29T19:00:00Z。
注意:仅网宿支持该参数,默认禁推 1 天,且最长支持禁推 30 天。例如,若禁推 30 天,则禁播时长会设置为:当前时间 +30 天。

请求示例

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

响应参数

参数类型描述
CodeNumber返回码。
MessageString操作结果描述。
RequestIdString请求 ID。
DataArray of Object响应数据。
└ CdnTypeStringCDN 类型。
  • ws:网宿。
  • aliyun:阿里云。
  • tencent:腾讯云。
  • huawei:华为云。
└ CdnResultStringCDN 处理结果。

响应示例

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

返回码

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

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

Previous

停止单流转码

Next

查询被禁止 CDN 推流的列表