最近更新时间:2023.09.25 21:09:55
首次发布时间:2021.11.10 15:01:04
调用接口禁止指定在线流的推流。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版禁推直播流接口。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ForbidStream | 接口名称。当前 API 的名称为 ForbidStream 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 否 |
| 域名空间名称。 说明 参数 |
Domain | String | 否 |
| 推流域名。 说明 参数 |
App | String | 是 | live | 应用名称 |
Stream | String | 是 | stream001 | 流名称 |
EndTime | String | 否 | 2021-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" } }
访问公共错误码获取详细信息。