文档中心
超低延迟直播
服务端 API
媒体服务接口
禁止 CDN 推流

禁止 CDN 推流

更新时间：2024-10-15 15:52

1 描述

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

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

2 接口原型

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

3 请求参数

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

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

4 请求示例

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

5 响应参数

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

6 响应示例

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

7 返回码

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

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