调用 DescribeClosedStreamInfoByPage 接口，分页查询历史流信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeClosedStreamInfoByPage | 接口名称。当前 API 的名称为 DescribeClosedStreamInfoByPage。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| PageNum | Integer | 是 | 1 | 查询数据的页码，取值范围为正整数。 |
| PageSize | Integer | 是 | 10 | 每页显示的数据条数，取值范围为 [1,1000]。 |
| Vhost | String | 否 | push.example.com | 域名空间，即直播流地址的域名所属的域名空间，默认为空，表示查询所有域名空间下的历史直播流。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的历史直播流使用的域名所属的域名空间。 |
| Domain | String | 否 | push.example.com | 直播流使用的域名，默认为空，表示查询所有当前域名空间下的历史直播流。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要查询的历史直播流使用的域名。 |
| App | String | 否 | live | 应用名称，取值与直播流地址中 AppName 字段取值相同，默认为空，表示查询所有应用名称。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。 |
| Stream | String | 否 | example_stream | 流名称，取值与直播流地址中 StreamName 字段取值相同，默认为空表示查询所有流名称。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。 |
Sort | String | 否 |
| 排列方式，根据直播流结束时间排序，默认值为
|
| EndTimeFrom | String | 是 | 2021-10-02T19:39:26+08:00 | 查询的起始时间，RFC3339 格式的时间戳，精度为秒。筛选直播流结束时间符合查询条件的历史流。 |
| EndTimeTo | String | 是 | 2021-10-02T19:39:26+08:00 | 查询的结束时间，RFC3339 格式表示的时间戳，精度为秒。筛选直播流结束时间符合查询条件的历史流。 |
SourceType | String | 否 |
| 历史直播流的来源类型，默认为空，表示查询所有来源类型，支持的取值及含义如下所示。
|
QueryType | String | 否 |
| 使用流名称进行查询的方式，默认值为
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| StreamInfoList | Array of StreamInfoList | - | 历史直播流信息列表。 |
| RoughCount | Integer | 1 | 查询结果中历史流的数量。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vhost | String | push.example.com | 历史直播流使用的域名所属的域名空间。 |
| Domain | String | push.example.com | 历史直播流使用的域名。 |
| App | String | live | 历史直播流使用的应用名称。 |
| Stream | String | example_stream | 历史直播流使用的流名称。 |
| StartTime | String | 2021-10-29T00:55:50Z | 直播流的开始时间，RFC3339 格式的 UTC 时间戳，精度为秒。 |
| EndTime | String | 2021-10-29T09:30:17Z | 直播流的结束时间，RFC3339 格式的 UTC 时间戳，精度为秒。 |
SourceType | String |
| 历史直播流的来源类型，取值及含义如下所示。
|
GET https://live.volcengineapi.com?Action=DescribeClosedStreamInfoByPage&Version=2023-01-01&PageNum=1&PageSize=10&Vhost=push.example.com&Domain=push.example.com&App=live&Stream=example_stream&Sort=desc&EndTimeFrom=2021-10-02T19:39:26+08:00&EndTimeTo=2021-10-02T19:39:26+08:00&SourceType=push&QueryType=fuzzy
{
"ResponseMetadata": {
"RequestId": "202110291823170102250842170814F5D6",
"Action": "DescribeClosedStreamInfoByPage",
"Version": "2023-01-01",
"Service": "live",
"Region": "cn-north-1"
},
"Result": {
"RoughCount": 1,
"StreamInfoList": [
{
"App": "live",
"Domain": "push.example.com",
"EndTime": "2021-10-29T09:55:50Z",
"StartTime": "2021-10-29T00:55:50Z",
"Stream": "example_stream",
"Vhost": "push.example.com"
}
]
}
}
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 400 | InvalidParam.Format | %s format error | 参数格式错误，请检查错误消息中指定参数中是否存在非法字符或 URL 格式错误。 |
| 400 | InvalidParam.OutOfRange | %s should be one of {[%s]}%s should be between %d and %d | 参数超出允许范围，请检查错误消息中指定参数的取值是否超出取值范围。 |
| 400 | InvalidParam.TimeLogic | startTime later than endTime, etc. | 传入的时间参数不符合时间逻辑，请检查是否存在以下问题。开始时间晚于结束时间过期时间早于当前时间 |
| 403 | RequestForbidden | - | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.AccountIDNotAllowed | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。 |
| 403 | AccessDenied | User is not authorized to perform: %s on resource: %s | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）或者接口权限。 |
| 404 | ResourceNotFound | - | 未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误，请联系技术支持。 |
| 500 | InternalError.DB | an internal error related to database occurred, please contact the administrator. | 出现与数据库相关的内部错误，请联系技术支持。 |
| 500 | InternalError.VhostOrDomain | an internal error related to vhost or domain occurred, please contact the administrator. | 出现与域名空间（Vhost）或域名（Domain）相关的内部错误。请联系技术支持。 |
| 502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时，请联系技术支持。 |
视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。