查询录制用量接口.md

查询录制用量接口

功能介绍

查询直播租户每小时录制的最大并发数，计算1小时内每分钟的并发总路数，取最大值做为统计值。

最大查询跨度31天，最大查询周期90天。

接口约束

该接口暂只支持查询“华北-北京四”区域，且部署在新版视频直播服务上的域名的相关数据。如何查询域名是新版还是旧版？

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/stats/record

表 1 路径参数

参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方法请参考获取项目ID。

表 2 Query参数

参数	是否必选	参数类型	描述
start_time	否	String	起始时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。 非整点时间按小时取整，若start_time为2020-08-18T07:20:40Z，则实际查询起始时间为2020-08-18T07:00:00Z。 若start_time为空，则默认查询最近24小时数据。
end_time	否	String	结束时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。 非整点时间按小时取整，若end_time为2020-08-18T08:20:40Z，则实际查询起始时间为2020-08-18T08:00:00Z。 若参数为空，默认为当前时间。结束时间需大于起始时间。

请求参数

表 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

表 4 响应Header参数

参数	参数类型	描述
X-request-id	String	请求的唯一标识。

表 5 响应Body参数

参数	参数类型	描述
record_data_list	Array of RecordData objects	采样数据列表。

表 6 RecordData

参数	参数类型	描述
concurrent_count	Integer	最大并发路数。
time	String	采样时间，每小时内最大并发路数时间点。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ 。

状态码： 400

表 7 响应Header参数

参数	参数类型	描述
X-request-id	String	请求的唯一标识。

表 8 响应Body参数

参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。

请求示例

GET /v2/{project_id}/stats/record?start_time=2020-08-18T07:00:00Z&end_time=2020-08-18T08:00:00Z

响应示例

状态码： 200

处理成功返回。

{
  "record_data_list" : [ {
    "time" : "2020-08-18T07:00:00Z",
    "concurrent_count" : 20
  }, {
    "time" : "2020-08-18T08:00:00Z",
    "concurrent_count" : 15
  } ]
}

状态码： 400

参数错误。

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: publish_domain"
}

状态码

状态码	描述
200	处理成功返回。
400	参数错误。

错误码

请参见错误码。