禁止某条流的推送，可以预设某个时刻将流恢复。
接口说明
调用本接口禁止某条流的推送，可以预设某个时刻将流恢复。如果没有预设时间，请通过 ResumeLiveStream 接口恢复直播流。本接口目前仅支持 publisher（主播推流）。
本接口通过添加黑名单的方式禁止直播流，上限为 10,000 路，超出限制将禁用失败，请您注意统计当前禁用流的数量。请通过 DescribeLiveStreamsBlockList 接口查询禁用流数量。
若只中断直播流，而不加入黑名单，则不会占用黑名单中的 10000 个名额。
QPS 限制
本接口的单用户 QPS 限制为 20 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:ForbidLiveStream |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| DomainName |
string |
是 |
推流域名。 |
demo.aliyundoc.com |
| AppName |
string |
是 |
推流所属应用名称。您可在流管理页面查看 AppName。 |
liveApp**** |
| StreamName |
string |
是 |
推流名称。您可在流管理页面查看 StreamName。 |
liveStream**** |
| LiveStreamType |
string |
是 |
用于指定主播推流还是客户端播流。目前仅支持：publisher（主播推流）。 |
publisher |
| Oneshot |
string |
否 |
是否只断流不加入黑名单。取值：
说明
不填默认为 no。 |
yes |
| ResumeTime |
string |
否 |
恢复流的时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明
|
2015-12-01T10:37:00Z |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
16BFE188-B193-4C3C-ADC5-79A7E31486EA |
示例
正常返回示例
JSON格式
{
"RequestId": "16BFE188-B193-4C3C-ADC5-79A7E31486EA"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidResumeTime.Malformed | Specified parameter ResumeTime is not valid. | |
| 400 | QuotaExceeded.Blacklist | Exceed max blacklist count limit | 超过黑名单最大数量 |
| 400 | ConfigAlreadyExists | Config has already exist. | |
| 500 | InternalError | The request processing has failed due to backend service exception. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。