You need to enable JavaScript to run this app.
导航
禁推直播流
最近更新时间:2023.10.12 17:39:56首次发布时间:2021.11.10 15:01:04

调用接口禁止指定在线流的推流。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版禁推直播流接口。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=ForbidStream&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringForbidStream接口名称。当前 API 的名称为 ForbidStream
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述

Vhost

String

push.example.com

域名空间名称。

说明

参数 DomainVhost 传且仅传一个。

Domain

String

push.example.com

推流域名。

说明

参数 DomainVhost 传且仅传一个。

AppStringlive应用名称
StreamStringstream001流名称
EndTimeString2021-04-14T00:00:01.000+08:00禁推的结束时间,RFC3339 格式的 UTC 时间,精度为 ms,禁推有效期最长为 90 天,默认为当前时间加 90 天

返回参数

本接口无特有的返回参数。更多信息请见返回结构

示例

请求示例

POST https://live.volcengineapi.com?Action=ForbidStream&Version=2020-08-01
{
  "Domain": "push.example.com",
  "App": "live",
  "Stream": "stream001",
  "EndTime": "2021-04-14T00:00:01.000+08:00"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "ForbidStream",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

访问公共错误码获取详细信息。