搜索水印模板
更新時間 2023-10-16 10:37:09
最近更新時間: 2023-10-16 10:37:09
分享文章
通過本接口可搜索已存在的水印模板。
接口功能介紹
通過本接口可搜索已存在的水印模板。
接口約束
本接口的單用戶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為私有，則此地址應為具有簽名的地址。 | //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": "//example.gdoss.xstore.daliqc.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錯誤碼請參考 錯誤碼說明。
