调用ForbidLiveStream禁止某条流的推送,可以预设某个时刻将流恢复。
说明 禁止直播流的上限为10,000路,超出限制将禁用失败,请您注意统计当前禁用流的数量。调用频率限制为20次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ForbidLiveStream |
系统规定参数。取值:ForbidLiveStream。 |
AppName | String | 是 | testApp |
播流所属应用名称。 |
DomainName | String | 是 | www.yourdomain.com |
主播流域名。 |
LiveStreamType | String | 是 | publisher |
用于指定主播推流还是客户端播流。目前仅支持:publisher(主播推流)。 |
StreamName | String | 是 | testStream |
播流名称。 |
RegionId | String | 否 | cn-beijing |
域名所属地域。 |
Oneshot | String | 否 | yes |
是否只断流不加入黑名单。取值:
|
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=testApp
&DomainName=www.yourdomain.com
&LiveStreamType=publisher
&StreamName=testStream
&<公共请求参数>
正常返回示例
XML
格式
<ForbidLiveStreamResponse>
<RequestId>16BFE188-B193-4C3C-ADC5-79A7E31486EA</RequestId>
</ForbidLiveStreamResponse>
JSON
格式
{
"RequestId":"16BFE188-B193-4C3C-ADC5-79A7E31486EA"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidResumeTime.Malformed | Specified parameter ResumeTime is not valid. | ResumeTime参数错误,请您确认该ResumeTime参数是否正确。 |
400 | ConfigAlreadyExists | Config has already exist. | 配置已添加。 |
访问错误中心查看更多错误码。