调用ForbidLiveStream禁止直播流。

使用说明

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

说明 禁止直播流的上限为10,000路，超出限制将禁用失败，请您注意统计当前禁用流的数量。请通过DescribeLiveStreamsBlockList接口查询禁用流数量。

QPS限制

本接口的单用户QPS限制为200次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ForbidLiveStream

系统规定参数。取值：ForbidLiveStream。

AppName String 是 liveApp****

推流所属应用名称。
DomainName String 是 demo.aliyundoc.com

推流域名。
LiveStreamType String 是 publisher

用于指定主播推流还是客户端播流。目前仅支持：publisher（主播推流）。

StreamName String 是 liveStream****

推流名称。
RegionId String 否 cn-beijing

域名所属地域。
Oneshot String 否 yes

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

  • yes：只断流不加黑名单（支持上行推送或上行播流）。
  • no：断流加入黑名单。
说明 不填默认为no。
ResumeTime String 否 2015-12-01T10:37:00Z

恢复流的时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

返回数据

名称 类型 示例值 描述
RequestId String 16BFE188-B193-4C3C-ADC5-79A7E31486EA

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ForbidLiveStream
&AppName=liveApp****
&DomainName=demo.aliyundoc.com
&LiveStreamType=publisher
&StreamName=liveStream****
&<公共请求参数>

正常返回示例

XML格式 

<ForbidLiveStreamResponse>
	  <RequestId>16BFE188-B193-4C3C-ADC5-79A7E31486EA</RequestId>
</ForbidLiveStreamResponse>

JSON格式 

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidResumeTime.Malformed Specified parameter ResumeTime is not valid. ResumeTime参数错误，请您确认该ResumeTime参数是否正确。
400 ConfigAlreadyExists Config has already exist. 配置已添加。

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