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

查询播放流量汇总接口

功能介绍

查询指定时间范围内流量汇总量。

最大查询跨度31天,最大查询周期一年。

接口约束

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

调试

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

URI

GET /v2/{project_id}/stats/traffic/summary

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

play_domains

Array

播放域名列表,最多支持查询100个域名,多个域名以逗号分隔。

app

String

应用名称。

stream

String

流名。

region

Array

区域列表。具体取值请参考省份名称缩写,不填写查询所有区域。

isp

Array

运营商列表。取值如下:

  • CMCC :移动

  • CTCC : 电信

  • CUCC :联通

  • OTHER :其他

不填写查询所有运营商。

protocol

String

请求协议

start_time

String

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

格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度31天,最大查询周期一年。

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

end_time

String

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

若参数为空,默认为当前时间。结束时间需大于起始时间。

请求参数

表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参数

参数

参数类型

描述

traffic_list

Array of TrafficSummaryData objects

域名对应的流量汇总列表。

表6 TrafficSummaryData

参数

参数类型

描述

value

Long

流量,单位为byte。

domain

String

域名。

状态码: 400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识。

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v2/{project_id}/stats/traffic/summary?play_domains=test.huawei.com&start_time=2020-06-04T07:00:00Z&end_time=2020-06-05T07:00:00Z

响应示例

状态码: 200

处理成功返回。

{
  "traffic_list" : [ {
    "value" : 2300,
    "domain" : "example.huawei.com"
  } ]
}

状态码: 400

处理失败返回。

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

状态码

状态码

描述

200

处理成功返回。

400

处理失败返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close