查询轮播任务监控数据接口 - ListCarouselTaskDetail
功能介绍
查询轮播任务监控数据接口，包括轮播任务帧率码率监控数据。
最大查询跨度3小时，最大查询周期7天。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/stats/carousel-task/detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
carousel_task_id |
是 |
String |
轮播任务id。 |
|
start_time |
否 |
String |
起始时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。最大查询跨度3小时，最大查询周期7天。 若参数为空，默认查询1小时数据。 |
|
end_time |
否 |
String |
结束时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。最大查询跨度3小时，最大查询周期7天。 若参数为空，默认为当前时间。结束时间需大于起始时间。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
请求的唯一标识。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
start_time |
String |
采样开始时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 |
|
end_time |
String |
采样结束时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 |
|
video_framerate_list |
Array of longs |
视频帧率信息列表，单位为fps。 |
|
video_bitrate_list |
Array of longs |
视频码率信息列表，单位为bps。 |
|
audio_framerate_list |
Array of longs |
音频帧率信息列表，单位为fps。 |
|
audio_bitrate_list |
Array of longs |
音频码率信息列表，单位为bps。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求的唯一标识。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
查询轮播任务监控
GET /v2/{project_id}/stats/carousel-task/detail?carousel_task_id=2d4f6a8c-1e3b-479d-8a6c-7e5d4b3f2a09
响应示例
状态码：200
处理成功返回。
{
"start_time" : "2022-02-04T07:00:00Z",
"end_time" : "2022-02-04T07:00:02Z",
"video_framerate_list" : [ 100, 200 ],
"video_bitrate_list" : [ 100, 200 ],
"audio_framerate_list" : [ 100, 200 ],
"audio_bitrate_list" : [ 100, 200 ]
}
状态码：400
处理失败返回。
{
"error_code" : "LIVE.100011001",
"error_msg" : "Invalid request parameter: carousel_task_id"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
处理成功返回。 |
|
400 |
处理失败返回。 |
错误码
请参见错误码。
