状态码
状态码 描述
200 处理成功返回。
400 处理失败返回。
错误码
请参见错误码。
12.3 查询流监控数据接口
功能介绍
查询流监控数据接口,包括帧率码率断流情况。
最大查询跨度1天,最大查询周期1个月。
返回的码率数据列表粒度为1秒钟。
接口约束
该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北 京一”)。此约束条件仅适用于中国站。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/stats/stream-detail
表12-17 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方法请参考获取项 目ID。
表12-18 Query 参数
参数 是否必选 参数类型 描述
publish_doma
in 是 String 推流域名。
app 是 String 应用名。
stream 是 String 流名。
start_time 否 String 起始时间。日期格式按照 ISO8601表示法,并使用UTC时
end_time 否 String 结束时间。日期格式按照
ISO8601表示法,并使用UTC时
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
表12-20 响应 Header 参数
参数 参数类型 描述
X-request-id String 请求的唯一标识。
表12-21 响应 Body 参数
参数 参数类型 描述
publish_doma
in String 推流域名
app String 应用名
stream String 流名 video_framera
te Array of StreamDetail objects
展示流视频帧率情况,帧率单位为fps。
如果出现断流则会出现多个时间段流信息,如:
"video_framerate": [ {
"start_time": "2022-02-04T07:00:00Z", "end_time": "2022-02-04T07:00:02Z", "data_list": [
"start_time": "2022-02-04T07:00:05ZVGltZQ==", "end_time": "2022-02-04T07:00:07ZVGltZQ==", "data_list": [
参数 参数类型 描述 video_bitrate Array of
StreamDetail objects
展示流视频码率情况,码率单位为Kbps。
如果出现断流则会出现多个时间段流信息,如:
"video_bitrate": [ {
"start_time": "2022-02-04T07:00:00Z", "end_time": "2022-02-04T07:00:02Z", "data_list": [
"start_time": "2022-02-04T07:00:05Z", "end_time": "2022-02-04T07:00:07Z", "data_list": [
ate Array of StreamDetail objects
展示流音频帧率情况,帧率单位为fps。
如果出现断流则会出现多个时间段流信息,如:
"audio_framerate": [ {
"start_time": "2022-02-04T07:00:00Z", "end_time": "2022-02-04T07:00:02Z", "data_list": [
"start_time": "2022-02-04T07:00:05Z", "end_time": "2022-02-04T07:00:06Z", "data_list": [
表12-22 StreamDetail
参数 参数类型 描述
start_time String 采样开始时间。日期格式按照ISO8601表示法,
并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。
end_time String 采样结束时间。日期格式按照ISO8601表示法,
并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。
data_list Array of
integers 流监控数据列表。
状态码: 400
表12-23 响应 Header 参数
参数 参数类型 描述
X-request-id String 请求的唯一标识。
表12-24 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误描述。
请求示例
GET /v2/{project_id}/stats/stream-detail?
app=live&stream=pull_stream&publish_domain=example.huawei.com
响应示例
状态码: 200 处理成功返回。
{ "publish_domain" : "example.huawei.com", "app" : "app",
"stream" : "pull_stream", "video_framerate" : [ {
"start_time" : "2022-02-04T07:00:00Z", "end_time" : "2022-02-04T07:00:02Z", "data_list" : [ 21, 22 ]
}, {
"start_time" : "2022-02-04T07:00:05Z", "end_time" : "2022-02-04T07:00:07Z", "data_list" : [ 13, 34, 21 ]
} ],
"video_bitrate" : [ {
"start_time" : "2022-02-04T07:00:00Z", "end_time" : "2022-02-04T07:00:02Z", "data_list" : [ 1326, 1268, 775 ] }, {
"start_time" : "2022-02-04T07:00:05Z", "end_time" : "2022-02-04T07:00:07Z", "data_list" : [ 1021, 2022 ]
} ],
"audio_framerate" : [ {
"start_time" : "2022-02-04T07:00:00Z", "end_time" : "2022-02-04T07:00:02Z", "data_list" : [ 10, 17 ]
}, {
"start_time" : "2022-02-04T07:00:05Z", "end_time" : "2022-02-04T07:00:06Z", "data_list" : [ 31, 33 ]
} ] }
状态码: 400 处理失败返回。
{ "error_code" : "LIVE.100011001",
"error_msg" : "Invalid request parameter: publish_domain"
}
状态码
状态码 描述
200 处理成功返回。
400 处理失败返回。
错误码
请参见错误码。