You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询禁推流列表

最近更新时间：2023.10.12 17:39:56

首次发布时间：2021.11.10 15:01:04

我的收藏

调用接口分页查询禁止直播推流的流列表。

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询禁推流地址接口。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：GET
  • 请求地址：https://live.volcengineapi.com?Action=DescribeForbiddenStreamInfoByPage&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是DescribeForbiddenStreamInfoByPage接口名称。当前 API 的名称为 DescribeForbiddenStreamInfoByPage。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。
PageNumInteger是1当前页码，取值范围 ≥1
PageSizeInteger是10分页大小，取值范围为 [1,1000]
VhostString否push.example.net域名空间名称，由 1 到 60 位数字、字母、下划线及"-"和"."组成
AppString否live应用名称，默认查询所有应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成
StreamString否stream001流名称，默认查询所有流名称，由 1 到 100 位数字、字母、下划线及"-"和"."组成，如果指定 Stream，必须同时指定 App 的值

Sort

String

否

desc

排列方式，根据推流结束时间排序。支持两种形式。缺省情况下为 desc。

  • asc：按从小到大升序排列；
  • desc：按从大到小降序排列。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述
StreamInfoListArray of StreamInfoList-禁推流的信息列表
RoughCountInteger1当前分页的禁推流数量

StreamInfoList

参数类型示例值描述
VhostStringpush.example.net域名空间名称
DomainStringpush.example.net推流域名
AppStringlive应用名称
StreamStringstream001流名称
CreateTimeString2021-10-19 16:16:14直播流开始时间
EndTimeString2022-01-19 05:00:36直播流结束时间

Status

Boolean

true

是否禁用。

  • true：禁用；
  • false：启用。

    • 示例

    请求示例

    GET https://live.volcengineapi.com?Action=DescribeForbiddenStreamInfoByPage&Version=2020-08-01&App=live&PageNum=1&PageSize=10&Sort=desc&Stream=stream001&Vhost=push.example.net

    返回示例

    {
  "ResponseMetadata": {
    "RequestId": "2021102918431901022508421700164AA1",
    "Action": "DescribeForbiddenStreamInfoByPage",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "RoughCount": 1,
    "StreamInfoList": [
      {
        "App": "cjhapp",
        "CreateTime": "2021-10-19 16:16:14",
        "Domain": "push.example.net",
        "EndTime": "2022-01-19 05:00:36",
        "Status": true,
        "Stream": "stream001",
        "Vhost": "push.example.net"
      }
    ]
  }
}

    错误码

    访问公共错误码获取详细信息。