logo
实时音视频
服务端 API
场景服务接口
当前页

ForbidCDNLiveStream

GET

https://rtc-api.zego.im/

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

注意

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

调用频率限制
同一个 AppID 下所有房间:20 次/秒

Request

Query Parameters

    Action stringrequired

    Possible values: [ForbidCDNLiveStream]

    接口原型参数

    https://rtc-api.zego.im?Action=ForbidCDNLiveStream

    AppId uint32required

    💡公共参数。AppId,ZEGO 分配的用户唯一凭证。

    SignatureNonce stringrequired

    💡公共参数。随机字符串。

    Timestamp int64required

    💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。

    Signature stringrequired

    💡公共参数。签名,用于验证请求的合法性。

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡公共参数。签名版本号。

    IsTest string

    Possible values: [true, false]

    Default value: false

    💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。

    StreamId stringrequired

    流 ID。

    ResumeTime string

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

Responses

成功
Schema
    Code number

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

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

    操作结果描述

    RequestId string

    请求 ID

    Data object[]
    响应数据
  • Array[
  • CdnType string

    CDN 类型:

    • ws:网宿
    • aliyun:阿里云
    • tencent:腾讯云
    • huawei:华为云
    CdnResult string

    CDN 处理结果

  • ]

Request
Collapse all
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
query
query
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

停止单流转码

Next

查询被禁止 CDN 推流的列表

当前页

返回到顶部