呼叫本介面透過水印範本 ID 查詢單個圖片水印範本或文字水印範本的設定資訊,包括圖片水印的位置、大小、顯示時間,以及文字水印的內容、字型、顏色、位置等參數設定資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vod:GetWatermark |
get |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| WatermarkId |
string |
是 |
需要查詢的圖文水印範本 ID,僅支援傳入單個水印範本 ID。可透過以下方式取得:
|
9bcc8bfadb843f*****09a2671d0df97 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
25818875-5F78-4A*****F6-D7393642CA58 |
| WatermarkInfo |
object |
圖文水印範本資訊。 |
|
| CreationTime |
string |
水印範本的建立時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2018-11-06T08:03:17Z |
| Type |
string |
水印範本的類型:
|
Image |
| IsDefault |
string |
是否為預設圖文水印範本:
|
NotDefault |
| FileUrl |
string |
水印檔案 URL(OSS 位址或 CDN 位址)。 說明
僅圖片水印範本會返回此參數。 |
https://outin-32*****f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/F85529C8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW**** |
| AppId |
string |
應用程式 ID。 |
app-**** |
| WatermarkConfig |
string |
圖文水印的設定資訊(JSON 字串),包括水印顯示位置、水印效果等設定。圖片水印和文字水印的設定參數不同,參數結構詳情請參閱 WatermarkConfig 。 |
{"ReferPos": "BottomRight","Height": "55","Width": "55","Dx": "8","Dy": "8" } |
| Name |
string |
水印範本名稱。 |
Image watermark test |
| WatermarkId |
string |
水印範本 ID。 |
505e2e287ea*****ecfddd386d384 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
"WatermarkInfo": {
"CreationTime": "2018-11-06T08:03:17Z",
"Type": "Image",
"IsDefault": "NotDefault",
"FileUrl": "https://outin-32*****f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/F85529C8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
"AppId": "app-****",
"WatermarkConfig": "{\"ReferPos\": \"BottomRight\",\"Height\": \"55\",\"Width\": \"55\",\"Dx\": \"8\",\"Dy\": \"8\" }",
"Name": "图片水印测试",
"WatermarkId": "505e2e287ea*****ecfddd386d384"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。