文档首页> 视频直播 Live> API参考> 数据统计分析> 查询历史推流列表接口
更新时间:2022-04-11 GMT+08:00
分享

查询历史推流列表接口

功能介绍

查询历史推流列表。

不能查询现推流。

最大查询跨度1天。

接口约束

该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北京一”)。此约束条件仅适用于中国站。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/stats/history/streams

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

domain

String

推流域名。

app

String

应用名称。

stream

String

流名称。

start_time

String

起始时间。日期格式按照ISO8601表示法,并使用UTC时间。

格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天。

若参数为空,默认查询1天数据。

end_time

String

结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。

若参数为空,默认为当前时间,最大查询跨度1天。结束时间需大于起始时间。

offset

Integer

分页编号,默认为0

limit

Integer

每页记录数。

取值范围:[1,100]

默认值:10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识。

表5 响应Body参数

参数

参数类型

描述

history_stream_list

Array of HistoryStreamInfo objects

历史流信息列表。

total

Integer

总记录数。

表6 HistoryStreamInfo

参数

参数类型

描述

domain

String

推流域名。

  • type为0表主播推流域名。

  • type为1表示第三方推流域名

app

String

应用名称。

stream

String

流名。

type

Integer

推流类型,取值如下:

  • 0:表示主播推流

  • 1:表示第三方推流

video_codec

String

视频编码格式。

audio_codec

String

音频编码格式。

client_ip

String

主播ip。

start_time

String

采样开始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。

end_time

String

采样结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。

状态码: 400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识。

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v2/{project_id}/stats/history/streams?domain=play.example.com&limit=10&offset=1

响应示例

状态码: 200

处理成功返回。

{
  "history_stream_list" : [ {
    "domain" : "example.huawei.com",
    "app" : "live",
    "stream" : "pull",
    "type" : 0,
    "video_codec" : "H264",
    "audio_codec" : "AAC",
    "client_ip" : "127.0.0.1",
    "start_time" : "2020-06-04T07:00:00Z",
    "end_time" : "2020-06-05T07:00:00Z"
  } ],
  "total" : 100
}

状态码: 400

参数错误。

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: domain"
}

状态码

状态码

描述

200

处理成功返回。

400

参数错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close