創建水印模板
更新時間 2025-04-16 14:08:22
最近更新時間: 2025-04-16 14:08:22
分享文章
通過本接口可創建一個水印模板配置。
接口功能介紹
通過本接口可創建一個水印模板配置。
接口約束
注意:水印模板需要事先上傳水印圖片至云點播,因此,調用該接口需要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 | 水印圖片地址 | //watermark-uuidxxx.gdoss.xstore.daliqc.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": "//watermark-uuidxxx.gdoss.xstore.daliqc.cn/xxxxxx?signature=xxxxxx"
}
}
狀態碼
| Http 狀態碼 | 狀態碼信息 | 狀態碼描述 |
|---|---|---|
| 0 | 表示業務成功 | 表示業務成功 |
| 400 | 請求參數有誤 | 請求參數有誤 |
| 403 | 用戶鑒權失敗,用戶無操作權限 | 用戶鑒權失敗,用戶無操作權限 |
| 404 | 請求的資源不存在,輸入錯誤的URL | 請求的資源不存在,輸入錯誤的URL |
| 500 | 業務執行異常 | 業務執行異常 |
錯誤碼
OpenAPI錯誤碼請參考 錯誤碼說明。