You need to enable JavaScript to run this app.
导航

查询历史流列表

最近更新时间2023.10.23 16:14:00

首次发布时间2023.09.25 14:34:03

调用接口分页查询历史流信息。

注意事项

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

请求说明

  • 请求方式:GET
  • 请求地址:https://live.volcengineapi.com?Action=DescribeClosedStreamInfoByPage&Version=2023-01-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeClosedStreamInfoByPage接口名称。当前 API 的名称为 DescribeClosedStreamInfoByPage
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01
PageNumInteger1当前页码,取值范围 ≥1。
PageSizeInteger10分页大小,取值范围为 [1,1000]。

Vhost

String

push.example.net

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

说明

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

Domain

String

push.example.net

推流域名(含删除域名)。

说明

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

Sort

String

desc

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

  • asc:按从小到大升序排列;
  • desc:按从大到小降序排列。
EndTimeFromString2021-10-02T19:39:26+08:00查询的起始时间,以 RFC3339 格式表示的 UTC 时间戳,精度为 s。筛选结束推流时间符合查询条件的历史流。
EndTimeToString2021-10-02T19:39:26+08:00查询的结束时间,以 RFC3339 格式表示的 UTC 时间戳,精度为 s。筛选结束推流时间符合查询条件的历史流。

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=2023-01-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": "2023-01-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"
      }
    ]
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
400InvalidParam.Format%s format error参数格式错误,请检查错误消息中指定参数中是否存在非法字符或 URL 格式错误。
400InvalidParam.OutOfRange%s should be one of {[%s]}%s should be between %d and %d参数超出允许范围,请检查错误消息中指定参数的取值是否超出取值范围。
400InvalidParam.TimeLogicstartTime later than endTime, etc.传入的时间参数不符合时间逻辑,请检查是否存在以下问题。开始时间晚于结束时间过期时间早于当前时间
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误,请联系技术支持
500InternalError.VhostOrDomainan internal error related to vhost or domain occurred, please contact the administrator.出现与域名空间(Vhost)或域名(Domain)相关的内部错误。请联系技术支持
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时,请联系技术支持