查询直播各区域指标分布接口
功能介绍
查询直播全球区域维度的详细数据接口。
如果不传入域名,则查询租户下所有播放域名的详细数据。
当查询租户级别数据时,参数app、stream不生效。
最大查询跨度1天,最大查询周期90天。
当查询观众数据时,仅支持查询FLV和RTMP流的在线人数
支持查询当天,当前数据延时少于5分钟。
如果用于对账,请查询三小时之前的数据。
接口约束
该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北京一”)。此约束条件仅适用于中国站。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/stats/area/detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
start_time |
是 |
String |
查询起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天,最大查询周期90天。 |
end_time |
是 |
String |
查询结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天,最大查询周期90天。 |
play_domains |
否 |
Array |
需查询的播放域名列表,最多支持查询100个域名。 |
app |
否 |
String |
需查询的app。 |
stream |
否 |
String |
流名称。 |
interval |
否 |
Integer |
查询数据的时间粒度。支持300(默认值)、3600和86400秒。若参数为空,则默认为300秒。 注意:若metric的值为player(观众数),则interval填入的值不生效,查询粒度interval默认为60秒。 |
isp |
否 |
Array |
运营商列表,取值如下:
若参数为空,则查询所有运营商。 |
area |
是 |
Array |
需查询的计费大区,取值如下:
中国内地返回结果为省份/直辖市的中文名称,比如:广东、上海; 海外大区与地区/国家的对应关系请参考地区/国家代码对照表。 |
metric |
是 |
String |
指标,取值如下:
|
protocol |
否 |
String |
请求协议,取值如下:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求的唯一标识。 |
参数 |
参数类型 |
描述 |
---|---|---|
data_list |
Array of AreaDetail objects |
时间戳及相应时间的指标数值 |
参数 |
参数类型 |
描述 |
---|---|---|
area |
String |
各个计费大区名称,例如CN |
summary |
Array of TimeValue objects |
时间戳及相应时间的指标数值 |
detail |
Array of AreaTimeValue objects |
各个大区下的具体省份、区域、国家的时间戳及相应时间的指标数值 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
各个大区下的具体省份、区域、国家的名称。 中国内地返回结果为省份/直辖市的中文名称,比如:广东、上海; 海外大区下的地区/国家对应关系请参考地区/国家代码对照表。 |
data |
Array of TimeValue objects |
当前时间返回指定指标的值 |
参数 |
参数类型 |
描述 |
---|---|---|
time |
String |
采样时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ |
value |
Long |
当前时间返回指定指标的值 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求的唯一标识。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
查询区域直播播放域名指标详情
GET /v2/{project_id}/stats/area/detail?start_time=2021-12-20T07:00:00Z&end_time=2021-12-20T07:00:00Z&play_domains=livepull-test.huaweicloud.com&area=CN&metric=traffic
响应示例
状态码: 200
处理成功返回。
{ "data_list" : [ { "area" : "AP2", "summary" : [ { "time" : "2021-12-20T07:00:00Z", "value" : 323 }, { "time" : "2021-12-20T09:05:00Z", "value" : 325 } ], "detail" : [ { "name" : "TH", "data" : [ { "time" : "2021-12-20T07:00:00Z", "value" : 223 }, { "time" : "2021-12-20T09:05:00Z", "value" : 123 } ] }, { "name" : "PH", "data" : [ { "time" : "2021-12-20T07:00:00Z", "value" : 123 }, { "time" : "2021-12-20T09:05:00Z", "value" : 223 } ] } ] } ] }
状态码: 400
参数错误。
{ "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: play_domains" }
状态码
状态码 |
描述 |
---|---|
200 |
处理成功返回。 |
400 |
参数错误。 |
错误码
请参见错误码。