接口功能介绍
通过本接口可创建一个水印模板配置。
接口约束
注意：水印模板需要事先上传水印图片至媒体存储（原 对象存储融合版），因此，调用该接口需要3步：
- 传递创建水印模板的基本参数。
- 成功之后，云点播服务返回参数中带一个 presigned 的 url 地址。使用该地址将图片上传到媒体存储（原 对象存储融合版）中。上传使用方法可参考文档使用预签名URL直传。
- 上传成功后，通过一个接口通知点播服务图片上传完成。
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /template/watermark/create
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 模板名称 | WaterMark | |
| favorite | 否 | Boolean | 是否为选定模板，不填默认为false。 | false | |
| position | 是 | Object | 水印所在的位置信息 | position | |
| remark | 否 | String | 水印模板备注 | 模板备注 |
表 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% |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码。 | 0 | |
| message | 是 | String | 错误文本信息，创建成功时，为空字符串。 | "" | |
| data | 是 | Object | 返回数据。 | data |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| templateId | 是 | Long | 模板ID | 100000000004 | |
| presignedUrl | 是 | String | 水印图片地址 | https://watermark-uuidxxx.gdoss.xstore.ctyun.cn/xxxxxx?signature=xxxxxx |
请求示例
{
"name": "",
"favorite": true,
"remark": "我的水印",
"position": {
"top": "10%",
"bottom": "10px",
"left": "10%",
"right": "10%",
"height": "10%",
"width": "10%"
}
}
响应示例
{
"code": 0,
"message": "",
"data" : {
"templateId" : 100000000004,
"presignedUrl": "https://watermark-uuidxxx.gdoss.xstore.ctyun.cn/xxxxxx?signature=xxxxxx"
}
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
