13.1 流管理
13.1.1 查询直播加速的带宽数据
功能介绍
说明
当前页面接口为历史版本API,仅供查询部署在旧版视频直播服务上的域名相关数据。如何查询 域名是新版还是旧版?此API未来可能停止维护,建议您使用新版视频直播统计API。您也可以 通过视频直播控制台使用新版直播统计功能,具体请参见直播统计。
查询直播加速的播流域名网络带宽监控数据
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/stream/bandwidth
表13-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方法请参考获取项 目ID。
表13-2 Query 参数
参数 是否必选 参数类型 描述
domain 否 String 播放域名,不指定域名表示查询
租户所有域名汇总带宽 start_time 否 String 查询起始时间,UTC时间,格
式:yyyy-MM-ddTHH:mm:ssZ end_time 否 String 查询结束时间,UTC时间,格
式:yyyy-MM-ddTHH:mm:ssZ。
● start_time与end_time均不 存在时,服务端从最近一个 统计周期的数据里查询。
● start_time存在、end_time 不存在时,end_time取当前 时间。
● start_time不存在、
end_time存在时,请求非
X-Auth-Token 是 String 用户Token,使用Token鉴权方 式时必选。通过调用IAM服务获
total Integer 查询结果的总元素数量
参数 参数类型 描述 bandwidth_inf
o Array of BandwidthIn fo objects
带宽信息
表13-5 BandwidthInfo
参数 参数类型 描述
bw_bps Integer 带宽峰值,单位:bps
timestamp String 带宽数据采样周期起始时刻,UTC时间,格式:
yyyy-MM-ddTHH:mm:ssZ
状态码: 400
表13-6 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
GET https://{endpoint}/v1/{project_id}/stream/bandwidth?domain=play.example.huawei.com
响应示例
状态码: 200
查询直播加速的带宽数据成功
{ "total" : 1,
"bandwidth_info" : [ { "bw_bps" : 1024,
"timestamp" : "2018-05-19T21:10:15Z"
} ] }
状态码: 400
查询直播加速的带宽数据失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
200 查询直播加速的带宽数据成功 400 查询直播加速的带宽数据失败
错误码
请参见错误码。
13.1.2 查询直播加速的流量数据
功能介绍
说明
当前页面接口为历史版本API,仅供查询部署在旧版视频直播服务上的域名相关数据。如何查询 域名是新版还是旧版?此API未来可能停止维护,建议您使用新版视频直播统计API。您也可以 通过视频直播控制台使用新版直播统计功能,具体请参见直播统计。
查询直播加速的播流域名网络流量监控数据
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/stream/traffic
表13-7 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方法请参考获取项 目ID。
表13-8 Query 参数
参数 是否必选 参数类型 描述
domain 否 String 播放域名,不指定域名表示查询
租户所有域名汇总流量 start_time 否 String 查询起始时间,UTC时间,格
式:yyyy-MM-ddTHH:mm:ssZ
参数 是否必选 参数类型 描述
end_time 否 String 查询结束时间,UTC时间,格
式:yyyy-MM-ddTHH:mm:ssZ。
● start_time与end_time均不 存在时,服务端从最近一个 统计周期的数据里查询。
● start_time存在、end_time 不存在时,end_time取当前 时间。
● start_time不存在、
end_time存在时,请求非
X-Auth-Token 是 String 用户Token,使用Token鉴权方 式时必选。通过调用IAM服务获
total Integer 查询结果的总元素数量 traffic_info Array of
TrafficInfo objects
流量信息
表13-11 TrafficInfo
参数 参数类型 描述
traffic Integer 采样周期内的总流量,单位:byte
timestamp String 流量数据采样周期起始时刻,UTC时间,格式:
yyyy-MM-ddTHH:mm:ssZ
状态码: 400
表13-12 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
GET https://{endpoint}/v1/{project_id}/stream/traffic?domain=play.example.huawei.com
响应示例
状态码: 200
查询直播加速的流量数据成功
{ "total" : 1, "traffic_info" : [ { "traffic" : 1024,
"timestamp" : "2018-05-19T21:10:15Z"
} ] }
状态码: 400
查询直播加速的流量数据失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
200 查询直播加速的流量数据成功 400 查询直播加速的流量数据失败
错误码
请参见错误码。
13.1.3 查询直播播放在线人数
功能介绍
说明
当前页面接口为历史版本API,仅供查询部署在旧版视频直播服务上的域名相关数据。如何查询 域名是新版还是旧版?此API未来可能停止维护,建议您使用新版视频直播统计API。您也可以 通过视频直播控制台使用新版直播统计功能,具体请参见直播统计。
查询加速的直播播放在线人数
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/stream/users
表13-13 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方法请参考获取项 目ID。
表13-14 Query 参数
参数 是否必选 参数类型 描述
domain 是 String 直播播放域名
app_name 否 String 应用名称
stream_name 否 String 流名称
start_time 否 String 查询开始时间,UTC时间,格
式:yyyy-mm-ddThh:mm:ssZ。
● 无开始时间表示查询最近统 计周期在线人数数据
● 只能查询最近90天内的数据
参数 是否必选 参数类型 描述
end_time 否 String 查询结束时间,UTC时间,格
式:yyyy-MM-ddTHH:mm:ssZ。
● start_time与end_time均不 存在时,服务端从最近一个 统计周期的数据里查询。
● start_time存在、end_time 不存在时,end_time取当前 时间。
● start_time不存在、
end_time存在时,请求非
X-Auth-Token 是 String 用户Token,使用Token鉴权方 式时必选。通过调用IAM服务获
total Integer 查询结果的总元素数量 user_info Array of
UserInfo objects
正在推流的音视频信息
表13-17 UserInfo
参数 参数类型 描述
user_num Integer 直播流的在线人数
timestamp String 操作执行的时间,UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ
状态码: 400
表13-18 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
GET https://{endpoint}/v1/{project_id}/stream/users?
domain=play.example.huawei.com&app_name=live&stream_name=xxx
响应示例
状态码: 200
查询直播播放在线人数成功
{ "total" : 1, "user_info" : [ { "user_num" : 1024,
"timestamp" : "2018-05-19T21:10:15Z"
} ] }
状态码: 400
查询直播播放在线人数失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
200 查询直播播放在线人数成功 400 查询直播播放在线人数失败