查询推流码率数据接口
功能介绍
查询推流监控码率数据接口。
最大查询跨度1天，最大查询周期1个月。
返回的码率数据列表粒度为1秒钟。
接口约束
该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据（不包含“华北-北京一”）。此约束条件仅适用于中国站。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/stats/stream/bitrate
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
domain |
是 |
String |
推流域名。 |
app |
是 |
String |
App名。 |
stream |
是 |
String |
流名。 |
start_time |
否 |
String |
起始时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天，最大查询周期1个月。 若参数为空，默认查询最近1小时数据。 |
end_time |
否 |
String |
结束时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。 若参数为空，默认为当前时间。结束时间需大于起始时间。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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 |
请求的唯一标识。 |
参数 |
参数类型 |
描述 |
|---|---|---|
bitrate_info_list |
Array of V2BitrateInfo objects |
用量详情。 |
参数 |
参数类型 |
描述 |
|---|---|---|
publish_domain |
String |
域名。 |
app |
String |
应用名称。 |
stream |
String |
流名。 |
start_time |
String |
采样开始时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 |
end_time |
String |
采样结束时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 |
data_list |
Array of integers |
码率信息列表，单位为Kbps。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
X-request-id |
String |
请求的唯一标识。 |
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
GET /v2/{project_id}/stats/stream/bitrate?app=live&stream=pull_stream&domain=example.huawei.com
响应示例
状态码： 200
处理成功返回。
{
"bitrate_info_list" : [ {
"publish_domain" : "example.huawei.com",
"app" : "app",
"stream" : "pull_stream",
"start_time" : "2020-06-04T07:00:00Z",
"end_time" : "2020-06-05T07:00:00Z",
"data_list" : [ 100, 200 ]
} ]
}
状态码： 400
处理失败返回。
{
"error_code" : "LIVE.100011001",
"error_msg" : "Invalid request parameter: domain"
}
状态码
状态码 |
描述 |
|---|---|
200 |
处理成功返回。 |
400 |
处理失败返回。 |
错误码
请参见错误码。
