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=DescribeClosedStreamInfoByPage&Version=2020-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DescribeClosedStreamInfoByPage接口名称。当前 API 的名称为 DescribeClosedStreamInfoByPage。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。
PageNumInteger是1当前页码，取值范围 ≥1
PageSizeInteger是10分页大小，取值范围为 [1,1000]

Vhost

String

否

push.example.net

视频直播服务的配置空间。

说明

  • 如果同时传入 Domain 和对应的 Vhost，会返回 Domain 下的历史流列表；
  • 如果 Domain 和 Vhost 同时缺省，会返回当前 AccountID 下的历史流列表。

Domain

String

否

push.example.net

推流域名（含删除域名）。

说明

  • 如果同时传入 Domain 和对应的 Vhost，会返回 Domain 下的历史流列表；
  • 如果 Domain 和 Vhost 同时缺省，会返回当前 AccountID 下的历史流列表。
AppString否live应用名称，默认查询所有应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成
StreamString否stream001流名称，默认查询所有流名称，由 1 到 100 位数字、字母、下划线及"-"和"."组成，如果指定Stream，必须同时指定App的值。

Sort

String

否

desc

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

  • asc：按从小到大升序排列；
  • desc：按从大到小降序排列。
EndTimeFromString是2021-10-02T19:39:26+08:00查询的起始时间，以 RFC3339 格式表示的 UTC 时间戳，例如，2021-10-02T19:39:26+8:00。筛选结束推流时间符合查询条件的历史流
EndTimeToString是2021-10-02T19:39:26+08:00查询的结束时间，以 RFC3339 格式表示的 UTC 时间戳，例如，2021-10-02T19:39:26+8:00。筛选结束推流时间符合查询条件的历史流

SourceType

String

否

push

表示推流方式，缺省情况查询全部推流方式。支持如下取值。

  • push：直推流；
  • relay：回源流。

返回参数

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

参数类型示例值描述
StreamInfoListArray of StreamInfoList-流信息列表
RoughCountInteger1流数量

StreamInfoList

参数类型示例值描述
VhostStringpush.example.netVhost 表示视频直播服务的配置空间
DomainStringpush.example.net域名
AppStringlive应用名称
StreamStringstream001流名称
StartTimeString2021-10-29 08:55:50直播流开始时间
EndTimeString2021-10-29 17:30:17直播流结束时间

SourceType

String

push

表示推流方式，缺省情况查询全部推流方式。支持如下取值。

  • push：直推流；
  • relay：回源流。

示例

请求示例

GET https://live.volcengineapi.com?Action=DescribeClosedStreamInfoByPage&Version=2020-08-01&App=live&Domain=push.example.net&EndTimeFrom=2021-10-02T19%3A39%3A26%2B08%3A00&EndTimeTo=2021-10-02T19%3A39%3A26%2B08%3A00&PageNum=1&PageSize=10&Sort=desc&SourceType=push&Stream=stream001&Vhost=push.example.net

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202110291823170102250842170814F5D6",
    "Action": "DescribeClosedStreamInfoByPage",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "RoughCount": 1,
    "StreamInfoList": [
      {
        "App": "live",
        "Domain": "push.example.net",
        "EndTime": "2021-10-29 17:31:57",
        "StartTime": "2021-10-29 17:30:17",
        "Stream": "stream001",
        "Vhost": "push.example.com"
      }
    ]
  }
}

错误码

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