文档首页> 视频直播 Live> API参考> 流管理> 查询禁止直播推流列表
更新时间:2022-04-11 GMT+08:00
分享

查询禁止直播推流列表

功能介绍

查询禁推黑名单列表

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/stream/blocks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

domain

String

推流域名

app_name

String

应用名称,不指定则查询domain下所有应用的禁止直播推流信息

stream_name

String

流名称

page

Integer

分页编号。 默认为0。

size

Integer

每页记录数。

取值范围:1-100。

默认为10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

查询结果的总元素数量

blocks

Array of StreamForbiddenList objects

禁推黑名单列表

表5 StreamForbiddenList

参数

参数类型

描述

app_name

String

应用名称

stream_name

String

流名称

resume_time

String

恢复流时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间,不指定则默认7天,最大禁推为90天

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/{project_id}/stream/blocks?domain=publish.example.huawei.com&app_name=live

响应示例

状态码: 200

查询禁止直播推流列表成功

{
  "total" : 2,
  "blocks" : [ {
    "app_name" : "live",
    "stream_name" : "test_001",
    "resume_time" : "2018-05-19T21:10:15Z"
  }, {
    "app_name" : "live",
    "stream_name" : "test_002",
    "resume_time" : "2018-06-12T20:10:10Z"
  } ]
}

状态码: 400

查询禁止直播推流列表失败

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

状态码

状态码

描述

200

查询禁止直播推流列表成功

400

查询禁止直播推流列表失败

错误码

请参见错误码

分享:

    相关文档

    相关产品

close