禁止某条流的推送,可以预设某个时刻将流恢复。
接口说明
调用本接口禁止某条流的推送,可以预设某个时刻将流恢复。如果没有预设时间,请通过 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:ForbidLiveStream | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "16BFE188-B193-4C3C-ADC5-79A7E31486EA"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidResumeTime.Malformed | Specified parameter ResumeTime is not valid. | ResumeTime参数错误,请您确认该ResumeTime参数是否正确。 |
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. | - |
访问错误中心查看更多错误码。