查询视频模板封面图
功能介绍
根据用户提供的过滤条件，查询视频模板封面图资源列表。
URI
GET /v1/aim/template-material-thumbnails
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
aim_resource_id |
是 |
String |
目标资源ID。 最小长度：1 最大长度：36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Content-Type |
是 |
String |
请求体参数类型，该字段必须设置为：application/json。 |
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
status |
String |
请求状态，固定200。 |
message |
String |
状态描述。 |
data |
Array of ListThumbnail objects |
视频封面图列表。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
视频封面图ID。 |
created_at |
String |
创建时间。 |
is_primary |
Integer |
是否作为视频素材封面。
|
file_name |
String |
文件名称。 |
aim_resource_id |
String |
资源ID。 |
obs_object_key |
String |
从OBS返回的文件Key。 |
image_rate |
String |
图像比例。
|
is_auto_gen |
Integer |
视频封面图是否自动从系统生成。
|
description |
String |
视频封面图的详细描述。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
结果状态码。 |
error_msg |
String |
结果详情。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
结果状态码。 |
error_msg |
String |
结果详情。 |
请求示例
根据AIM视频资源ID查询视频模板封面图列表。
https://koomessage.myhuaweicloud.com/v1/aim/template-material-thumbnails?aim_resource_id=HWR100017516
响应示例
状态码： 200
返回信息。
{
"status" : "200",
"message" : "success",
"data" : [ {
"id" : "db910127-dc96-4751-a756-001f66c6eb6f",
"created_at" : "2023-07-04 14:31:46.0",
"is_primary" : 1,
"file_name" : "1_cropped_bg.png",
"aim_resource_id" : "HWR100046551",
"obs_object_key" : "bhvdepxbjo-5355528098406562.jpg",
"image_rate" : "oneToOne",
"description" : null,
"is_auto_gen" : 1
}, {
"id" : "dbc604fe-c87d-4020-8791-267d9b526387",
"created_at" : "2023-05-27 01:27:25.0",
"is_primary" : 0,
"file_name" : "1_cropped_kahve.jpg",
"aim_resource_id" : "HWR100034106",
"obs_object_key" : "ylvwpfuxtw-12013592016942369.jpg",
"image_rate" : "oneToOne",
"description" : null,
"is_auto_gen" : 0
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
返回信息。 |
400 |
非法参数。 |
500 |
内部错误。 |
错误码
请参见错误码。
