ForbidLiveStream - 禁止直播流

更新时间:2025-05-13 10:40:52

禁止某条流的推送,可以预设某个时刻将流恢复。

接口说明

调用本接口禁止某条流的推送,可以预设某个时刻将流恢复。如果没有预设时间,请通过 ResumeLiveStream 接口恢复直播流。本接口目前仅支持 publisher(主播推流)。

说明
  • 本接口通过添加黑名单的方式禁止直播流,上限为 10,000 路,超出限制将禁用失败,请您注意统计当前禁用流的数量。请通过 DescribeLiveStreamsBlockList 接口查询禁用流数量。
  • 若只中断直播流,而不加入黑名单,则不会占用黑名单中的 10000 个名额。
  • QPS 限制

    本接口的单用户 QPS 限制为 20 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

    调试

    您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

    • 操作:是指具体的权限点。
    • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
    • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
      • 对于必选的资源类型,用前面加 * 表示。
      • 对于不支持资源级授权的操作,用全部资源表示。
    • 条件关键字:是指云产品自身定义的条件关键字。
    • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    操作访问级别资源类型条件关键字关联操作
    live:ForbidLiveStreamget
    *全部资源
    *

    请求参数

    名称类型必填描述示例值
    名称类型必填描述示例值
    DomainNamestring

    推流域名。

    demo.aliyundoc.com
    AppNamestring

    推流所属应用名称。您可在流管理页面查看 AppName。

    liveApp****
    StreamNamestring

    推流名称。您可在流管理页面查看 StreamName。

    liveStream****
    LiveStreamTypestring

    用于指定主播推流还是客户端播流。目前仅支持:publisher(主播推流)。

    publisher
    Oneshotstring

    是否只断流不加入黑名单。取值:

    • yes:只断流不加黑名单(支持上行推送或上行播流)。

    • no:断流加入黑名单。

    说明
    不填默认为 no。
    yes
    ResumeTimestring

    恢复流的时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    说明
  • Oneshot 参数为 no 时,ResumeTime 不传值时默认禁止直播流指定时间为 6 个月。
  • 如果传值则可在 ResumeTime 指定的时间点解除限制,恢复直播流。
  • 2015-12-01T10:37:00Z

    返回参数

    名称类型描述示例值
    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    16BFE188-B193-4C3C-ADC5-79A7E31486EA

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "16BFE188-B193-4C3C-ADC5-79A7E31486EA"
    }

    错误码

    HTTP status code错误码错误信息描述
    HTTP status code错误码错误信息描述
    400InvalidResumeTime.MalformedSpecified parameter ResumeTime is not valid.ResumeTime参数错误,请您确认该ResumeTime参数是否正确。
    400QuotaExceeded.BlacklistExceed max blacklist count limit超过黑名单最大数量
    400ConfigAlreadyExistsConfig has already exist.配置已添加。
    500InternalErrorThe request processing has failed due to backend service exception.-

    访问错误中心查看更多错误码。

    • 本页导读 (1)
    • 接口说明
    • QPS 限制
    • 调试
    • 授权信息
    • 请求参数
    • 返回参数
    • 示例
    • 错误码
    AI助理

    点击开启售前

    在线咨询服务

    你好,我是AI助理

    可以解答问题、推荐解决方案等