11.3 查询播放带宽峰值接口 11.4 查询播放流量汇总接口 11.5 查询观众趋势接口
11.6 查询直播拉流HTTP状态码接口 11.7 查询转码用量接口
11.8 查询录制用量接口 11.9 查询截图用量接口 11.10 查询上行带宽数据接口 11.11 查询域名维度推流路数接口 11.12 查询历史推流列表接口 11.13 查询播放画像信息接口 11.14 查询直播各区域指标分布接口
11.1 查询播放带宽趋势接口
功能介绍
查询播放域名带宽数据。
最大查询跨度31天,最大查询周期一年。
接口约束
该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北 京一”)。此约束条件仅适用于中国站。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/stats/bandwidth/detail
表11-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方法请参考获取项 目ID。
表11-2 Query 参数
参数 是否必选 参数类型 描述
play_domains 是 Array 播放域名列表,最多支持查询 100个域名,多个域名以逗号分 隔。
app 否 String 应用名称。
stream 否 String 流名。
country 否 Array 国家列表。具体取值请参考国家
名称缩写,不填写查询所有国 家。
region 否 Array 区域列表。具体取值请参考省份
名称缩写,不填写查询所有区 域。
isp 否 Array 运营商列表,取值如下:
● CMCC :移动
● CTCC :电信
● CUCC :联通
● OTHER :其他 不填写查询所有运营商。
protocol 否 String 请求协议
interval 否 Integer 查询数据的时间粒度。支持300
(默认值), 3600和86400秒。
不传值时,使用默认值300秒。
参数 是否必选 参数类型 描述
start_time 否 String 起始时间。日期格式按照 ISO8601表示法,并使用UTC时 间。
格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度 31天,最大查询周期一年。
若参数为空,默认查询7天数 据。
end_time 否 String 结束时间。日期格式按照
ISO8601表示法,并使用UTC时 间。
格式为:YYYY-MM-DDThh:mm:ssZ。
若参数为空,默认为当前时间。
结束时间需大于起始时间。
请求参数
表11-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
表11-4 响应 Header 参数
参数 参数类型 描述
X-request-id String 请求的唯一标识。
表11-5 响应 Body 参数
参数 参数类型 描述
data_list Array of V2Bandwidth Data objects
采样数据列表
表11-6 V2BandwidthData
参数 参数类型 描述
value Long 带宽值,单位为bps。
time String 采样时间。日期格式按照ISO8601表示法,并使 用UTC时间。
格式为:YYYY-MM-DDThh:mm:ssZ。
状态码: 400
表11-7 响应 Header 参数
参数 参数类型 描述
X-request-id String 请求的唯一标识。
表11-8 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误描述。
请求示例
GET /v2/{project_id}/stats/bandwidth/detail?
play_domains=play.example.com&start_time=2020-06-04T07:00:00Z&end_time=2020-06-05T07:00:00Z
响应示例
状态码: 200 处理成功返回。
{ "data_list" : [ {
"time" : "2020-06-04T07:00:00Z", "value" : 0
}, {
"time" : "2020-06-04T07:05:00Z", "value" : 325
} ] }
状态码: 400 处理失败返回。
{ "error_code" : "LIVE.100011001",
"error_msg" : "Invalid request parameter: play_domains"
}
状态码
状态码 描述
200 处理成功返回。
400 处理失败返回。
错误码
请参见错误码。