查询水印模板 - ListWatermarkTemplate
功能介绍
查询自定义水印模板。支持指定模板ID查询,或分页全量查询。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
mpc:watermarkTempate:view
List
-
-
-
-
URI
GET /v1/{project_id}/template/watermark
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
template_id |
否 |
Array of integers |
水印模板ID,最多10个 |
|
page |
否 |
Integer |
分页编号。查询指定“task_id”时,该参数无效。 默认值:0。 |
|
size |
否 |
Integer |
每页记录数。取值范围:[1,100],指定template_id时该参数无效 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
|
X-Project_Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
水印模板总数。 |
|
templates |
Array of WatermarkTemplate objects |
水印模板 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
dx |
String |
水印图片起点相对输出视频顶点的水平偏移量。 设置方法有如下两种:
示例:输出视频分辨率宽1920,设置“dx”为“0.1”,“referpos”为“TopRight”(右上角),则水印图片右上角到视频右顶点在水平方向上偏移距离为192。 |
|
dy |
String |
水印图片起点相对输出视频顶点的垂直偏移量。
示例:输出视频分辨率高1080,设置“dy”为“0.1”,“referpos”为“TopRight”(右上角),则水印图片右上角到视频右顶点在垂直方向上的偏移距离为108。 |
|
referpos |
String |
水印的位置。 取值如下:
|
|
timeline_start |
String |
水印开始时间,与“timeline_duration”配合使用。 取值范围:数字。 单位:秒。 |
|
timeline_duration |
String |
水印持续时间,与“timeline_start”配合使用。 取值范围:[数字,ToEND]。“ToEND”表示持续到视频结束。 默认值:ToEND。 |
|
random_time_min |
Float |
轮转间隔时间最小值,单位:秒 |
|
random_time_max |
Float |
轮转间隔时间最大值,单位:秒 |
|
image_process |
String |
图片水印处理方式,type设置为Image时有效。 取值如下:
|
|
width |
String |
水印图片宽,值有两种形式:
|
|
height |
String |
水印图片高,值有两种形式:
|
|
base |
String |
水印叠加母体 取值如下:
|
|
template_id |
Integer |
水印模板ID |
|
template_name |
String |
水印模板名称,最大支持64个字符。 |
|
type |
String |
水印类型,当前只支持Image(图片水印)。后续根据需求再支持Text(文字水印)。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v1/{project_id}/templates/watermark?template_id =2743
响应示例
状态码:200
查询水印模板成功。
{
"total" : 1,
"templates" : [ {
"dx" : 0.1,
"dy" : 0.1,
"referpos" : "TopRight",
"timeline_start" : 0,
"timeline_duration" : "ToEND",
"image_process" : "Original",
"width" : 0.1,
"height" : 0.1,
"base" : "input",
"template_id" : 2743,
"template_name" : "createWatermarkTemplate1xYcdyUz",
"type" : "Image"
} ]
}
状态码:403
查询水印模板失败。
{
"error_code" : "MPC.10202",
"error_msg" : "Invalid request parameter."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询水印模板成功。 |
|
403 |
查询水印模板失败。 |
错误码
请参见错误码。