接口功能介绍
通过本接口可搜索已存在的水印模板。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /template/watermark/search
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| templateId | 是 | Long | 模板id | 100000000004 | |
| name | 否 | String | 模板的名称，模糊匹配。 | 自定义模板 | |
| favorite | 否 | Boolean | 是否为默认模板 | true | |
| pageSize | 否 | Integer | 每页的数量，当 pageSize 与 pageIndex 为空时，表示不分页。 | 10 | |
| pageIndex | 否 | Integer | 页码，由0开始，当 pageSize 与 pageIndex 为空时，表示不分页。 | 1 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码。 | 0 | |
| message | 是 | String | 错误文本信息，执行成功时，为空字符串。 | "" | |
| data | 是 | Array of String | 返回数据。 | data | |
| total | 是 | Integer | 查询结果总条数。 | 2 | |
| pageCount | 是 | Integer | 查询结果总页数。 | 1 |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| templateId | 是 | Long | 模板id | 100000000004 | |
| name | 是 | String | 模板名称 | WaterMark | |
| favorite | 是 | Boolean | 是否为选定模板。 | false | |
| storage | 是 | Object | 水印图片的存储地址。 | storage | |
| position | 是 | Object | 水印在视频画面中的位置。 | position | |
| remark | 否 | String | 水印模板备注 | 模板备注 |
表 storage
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| url | 是 | String | 上传之后s3地址，如果当前Bucket为私有，则此地址应为具有签名的地址。 | http://to.picture.url |
表 position
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| top | 否 | String | 水印离屏幕顶部的距离，默认为0。可以指定像素（例如 30px）或者百分比（例如 5%）。top与bottom只能指定其中一个，如果两个都传入取top值。 | 10% | |
| bottom | 否 | String | 水印离屏幕底部的距离，默认为0。可以指定像素（例如 30px）或者百分比（例如 5%）。top与bottom只能指定其中一个，如果两个都传入取top值。 | 10px | |
| left | 否 | String | 水印离屏幕左侧的距离，默认为0。可以指定像素（例如 30px）或者百分比（例如 5%）。left与right只能指定其中一个，如果两个都传入取left值。 | 10% | |
| right | 否 | String | 水印离屏幕右侧的距离，默认为0。可以指定像素（例如 30px）或者百分比（例如 5%）。left与right只能指定其中一个，如果两个都传入取left值。 | 10px | |
| height | 否 | String | 图片的高度。可以指定像素（例如 30px）或者百分比（例如 5%）。当指定其中一个，另一个不指定时，另一个参数会根据实际高宽比进行缩放。 | 10% | |
| width | 否 | String | 图片的宽度。可以指定像素（例如 30px）或者百分比（例如 5%）。当指定其中一个，另一个不指定时，另一个参数会根据实际高宽比进行缩放。 | 10% |
请求示例
{
"templateId": 100000000004,
"name": "自定义模板",
"favorite": true,
"pageSize": 10,
"pageIndex": 0
}
响应示例
{
"code": 0,
"message": "",
"data": [{
"templateId": 100000000004,
"name": "水印LOGO1",
"favorite": "true",
"remark": "我的水印模板",
"storage": {
"url": "https://example.gdoss.xstore.ctyun.cn/sample.jpg"
},
"position": {
"top": "10%",
"bottom": "10px",
"left": "10%",
"right": "10%",
"height": "10%",
"width": "10%"
}
}
],
"total": 2,
"pageCount": 1
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
