查询截图任务结果列表 - ListThumbnailInfo
功能介绍
查询截图任务结果列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/asset/thumbnails
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
asset_id |
否 |
String |
截图对应媒资id的截图,只支持单个媒资。 |
|
task_id |
否 |
String |
截图对应的任务id,只支持单个任务查询。 |
|
offset |
否 |
Integer |
查询偏移量。取值范围[0,20000],默认值:0。 |
|
limit |
否 |
Integer |
查询一页返回数。取值范围[1,100],默认值:10。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 |
|
X-Auth-Token |
是 |
String |
IAM token |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
截图结果总数 |
|
thumbnails |
Array of QueryThumbnailInfo objects |
截图结果列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
截图任务 |
|
thumbnail_para |
Thumbnail object |
截图参数。 须知:设置截图参数会产生相应的截图费用。为避免产生截图费用,可不设置此参数。 |
|
thumbnail_count |
Integer |
视频截图个数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
截图类型。 取值如下: |
|
quantity |
Integer |
type取值为quantity时必填。 按照指定张数,根据视频时长等分视频截图。 取值范围:[1,10]之间的整数。 |
|
quantity_time |
Integer |
type取值为quantity时选填。 按照指定时间间隔取指定张数截图。 取值范围:[0,2147483647]之间的整数。 |
|
time |
Integer |
根据时间间隔采样时的时间间隔值。单位:秒。 type取值为time时。 默认值:12 取值范围:[0,100]之间的整数。 |
|
dots |
Array of integers |
type取值为dots时必填。指定时间截图时的时间点数组。 |
|
cover_position |
Integer |
该值表示指定第几张截图作为封面。 默认值:1。 |
|
format |
Integer |
截图文件格式。 取值如下: 默认值:1 。 |
|
aspect_ratio |
Integer |
纵横比,图像缩放方式。 取值如下: 默认值:0。 |
|
max_length |
Integer |
截图最长边的尺寸。 单位:像素。 宽边尺寸按照该尺寸与原始视频像素等比缩放计算。 默认值:480。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
无
响应示例
状态码:200
处理成功返回。
{
"total" : 0,
"thumbnails" : [ {
"thumbnail_para" : null
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
处理成功返回。 |
|
400 |
处理失败返回。 |
错误码
请参见错误码。