接口功能介绍
通过该接口可实现对直播流的禁推和解禁。
使用说明
单个用户一分钟限制调用10000次,并发不超过100。
如果使用该接口,需要提前先联系天翼云运营开启域名禁推开关。
禁推场景下,最长支持封禁时长为14天。
接口详情
请求方式:post
请求路径:/live/stream/forbid-resume-stream
请求参数
参数名 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
action | int | 操作类型 | 是 | 2(解禁);3(禁推) |
end_time | int | 任务结束时间戳 | 否 | 单位秒。若操作类型 = 2(解禁)时,不生效; 若操作类型 = 3(禁播)时,必填,为禁播结束时间。 |
stream_list | list | 流对象列表 | 是 | |
stream_list[*].domain | string | 域名名称 | 是 | |
stream_list[*].app_name | string | 发布点 | 是 | |
stream_list[*].stream_name | string | 流名 | 是 |
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态码。成功时为100000 |
message | string | 描述信息。成功时为success |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/live/stream/forbid-resume-stream
请求示例1:禁播
{
"action": 3,
"end_time": 1652168400,
"stream_list": [
{
"domain": "ctyun.cn",
"app_name": "xxxxx",
"stream_name": "xxxxx"
}
]
}
正常响应示例
{
"code": 100000,
"message": "success"
}
请求示例2:解禁
{
"action": 2,
"stream_list": [
{
"domain": "ctyun.cn",
"app_name": "xxxxx",
"stream_name": "xxxxx"
}
]
}
正常响应示例
{
"code": 100000,
"message": "success"
}
错误码请参考:参数code和message含义