功能介绍
查询直播全球区域维度的详细数据接口。
最大查询跨度1天,最大查询周期90天。
支持查询当天,当前数据延时少于1分钟。
接口约束
该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北 京一”)。此约束条件仅适用于中国站。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/stats/area/detail
表11-108 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方法请参考获取项 目ID。
表11-109 Query 参数
参数 是否必选 参数类型 描述
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 需查询的播放域名列表,最多支 持查询10个域名。
app 否 String 需查询的app。
stream 否 String 流名称。
interval 否 Integer 查询数据的时间粒度。支持300
(默认值)、3600和86400秒。
metric 是 String 指标,取值如下:
● bandwidth:带宽
● traffic:流量
● player:观众数
protocol 否 String 请求协议,取值如下:
● flv
● hls
请求参数
表11-110 请求 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-111 响应 Header 参数
参数 参数类型 描述
X-request-id String 请求的唯一标识。
表11-112 响应 Body 参数
参数 参数类型 描述
data_list Array of AreaDetail objects
时间戳及相应时间的指标数值
表11-113 AreaDetail
参数 参数类型 描述
area String 各个计费大区名称,例如CN summary Array of
TimeValue objects
时间戳及相应时间的指标数值
参数 参数类型 描述 detail Array of
AreaTimeVal ue objects
各个大区下的具体省份、区域、国家的时间戳及 相应时间的指标数值
表11-114 AreaTimeValue
参数 参数类型 描述
name String 各个大区下的具体省份、区域、国家的名称。
具体取值请参考国家名称缩写和省份名称缩写。
data Array of TimeValue objects
当前时间返回指定指标的值
表11-115 TimeValue
参数 参数类型 描述
time String 采样时间。日期格式按照ISO8601表示法,并使 用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ
value Long 当前时间返回指定指标的值
状态码: 400
表11-116 响应 Header 参数
参数 参数类型 描述
X-request-id String 请求的唯一标识。
表11-117 响应 Body 参数
参数 参数类型 描述
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=example.huawei.com&a
"time" : "2021-12-20T07:00:00Z", "value" : 323
}, {
"time" : "2021-12-20T09:05:00Z", "value" : 325
{ "error_code" : "LIVE.100011001",
"error_msg" : "Invalid request parameter: domain"
}
状态码
状态码 描述
200 处理成功返回。
400 参数错误。
错误码
请参见错误码。
12 流监控
12.1 查询推流帧率数据接口