功能介绍
查询自定义水印模板。支持指定模板ID查询，或分页全量查询。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/template/watermark
表7-14 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID
表7-15 Query 参数
参数 是否必选 参数类型 描述
template_id 否 Array 水印模板ID，最多10个
page 否 Integer 分页编号。查询指定
“task_id”时，该参数无效。
默认值：0。
size 否 Integer 每页记录数。取值范围：
[1,100]，指定template_id时该 参数无效
API 参考 7 水印模板接口
请求参数
表7-16 请求 Header 参数
参数 是否必选 参数类型 描述
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
表7-17 响应 Body 参数
参数 参数类型 描述
total Integer 水印模板总数。
templates Array of WatermarkT emplate objects
水印模板
表7-18 WatermarkTemplate
referpos String 水印的位置。
取值如下：
● TopRight：右上角。
● TopLeft：左上角。
● BottomRight：右下角。
● BottomLeft：左下角。
timeline_start String 水印开始时间，与“timeline_duration”配合使 用。
取值范围：数字。
单位：秒。
timeline_dura
tion String 水印持续时间，与“timeline_start”配合使用。
取值范围：[数字，ToEND]。“ToEND”表示持 续到视频结束。
默认值：ToEND。
API 参考 7 水印模板接口
参数 参数类型 描述 image_proces
s String 图片水印处理方式，type设置为Image时有效。
取值如下：
● Original：只做简单缩放，不做其他处理。
● Grayed：彩色图片变灰。
● Transparent：透明化。
width String 水印图片宽，值有两种形式：
● 整数型代水印图片宽的像素值，范围[8，
4096]，单位px。
● 小数型代表相对输出视频分辨率宽的比率，范 围(0,1)，支持4位小数，如0.9999，超出部分 系统自动丢弃。
height String 水印图片高，值有两种形式：
● 整数型代表水印图片高的像素值，范围[8，
4096]，单位px。
● 小数型代表相对输出视频分辨率高的比率，范 围(0，1)，支持4位小数，如0.9999，超出部 分系统自动丢弃。
base String 水印叠加母体
取值如下：
● input ：水印叠加在输入片源上，转码输出后 实际大小按图像等比例缩放
● output ：水印叠加在转码输出文件上。
template_id Integer 水印模板ID template_na
me String 水印模板名称。
type String 水印类型，当前只支持Image（图片水印）。后 续根据需求再支持Text（文字水印）。
状态码： 403
表7-19 响应 Body 参数
参数 参数类型 描述
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 查询水印模板失败。
错误码
请参见错误码。
API 参考 7 水印模板接口
8 媒资转码接口
8.1 新建转码任务