最近更新时间：2023.09.25 21:09:55
首次发布时间：2021.11.10 15:01:04
调用接口分页查询历史流信息。
说明
该接口数据历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询历史流地址接口。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeClosedStreamInfoByPage | 接口名称。当前 API 的名称为 DescribeClosedStreamInfoByPage。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
| PageNum | Integer | 是 | 1 | 当前页码，取值范围 ≥1 |
| PageSize | Integer | 是 | 10 | 分页大小，取值范围为 [1,1000] |
Vhost | String | 否 |
| 视频直播服务的配置空间。 说明
|
Domain | String | 否 |
| 推流域名（含删除域名）。 说明
|
| App | String | 否 | live | 应用名称，默认查询所有应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成 |
| Stream | String | 否 | stream001 | 流名称，默认查询所有流名称，由 1 到 100 位数字、字母、下划线及"-"和"."组成，如果指定Stream，必须同时指定App的值。 |
Sort | String | 否 |
| 排列方式，根据结束时间排序。支持两种形式。缺省情况下为 desc。
|
| EndTimeFrom | String | 是 | 2021-10-02T19:39:26+08:00 | 查询的起始时间，以 RFC3339 格式表示的 UTC 时间戳，例如，2021-10-02T19:39:26+8:00。筛选结束推流时间符合查询条件的历史流 |
| EndTimeTo | String | 是 | 2021-10-02T19:39:26+08:00 | 查询的结束时间，以 RFC3339 格式表示的 UTC 时间戳，例如，2021-10-02T19:39:26+8:00。筛选结束推流时间符合查询条件的历史流 |
SourceType | String | 否 |
| 表示推流方式，缺省情况查询全部推流方式。支持如下取值。
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| StreamInfoList | Array of StreamInfoList | - | 流信息列表 |
| RoughCount | Integer | 1 | 流数量 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vhost | String | push.example.net | Vhost 表示视频直播服务的配置空间 |
| Domain | String | push.example.net | 域名 |
| App | String | live | 应用名称 |
| Stream | String | stream001 | 流名称 |
| StartTime | String | 2021-10-29 08:55:50 | 直播流开始时间 |
| EndTime | String | 2021-10-29 17:30:17 | 直播流结束时间 |
SourceType | String |
| 表示推流方式，缺省情况查询全部推流方式。支持如下取值。
|
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" } ] } }
访问公共错误码获取详细信息。