全部產品
Search

搜尋本產品

    ：AddWatermark - 添加圖文浮水印模板

    文件中心

    ：AddWatermark - 添加圖文浮水印模板

    更新時間：Dec 15, 2025

    為了簡化浮水印任務的處理過程，ApsaraVideo for VOD將複雜的浮水印位置、浮水印大小、浮水印文字的字型、顏色等浮水印參數固化成模板，並通過具有唯一性的浮水印模板ID來指代。調用本介面可以添加圖片浮水印模板或文字浮水印模板。

    介面說明

    • 調用本介面可以添加圖片浮水印模板（Image）或文字浮水印模板（Text），其中，圖片浮水印模板支援如下格式：靜態圖片（PNG）、動態圖片（GIF、APNG、MOV）。

    • 調用本介面添加圖文浮水印模板後，您還需調用 AddTranscodeTemplateGroup 或 UpdateTranscodeTemplateGroup 介面，將圖文浮水印模板關聯到轉碼模板組上，以便後續發起浮水印轉碼時選用。

    • 為視頻添加圖文浮水印的詳細資料，請參見視頻圖文浮水印。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vod:AddWatermark

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Type

    string

    是

    浮水印模板類型：

    • Image（預設）：圖片浮水印模板。

    • Text：文字浮水印模板。

    Image
    Name

    string

    是

    浮水印模板名稱。

    • 僅支援中英文、數字。

    • 長度不超過 128 個位元組。

    • UTF-8 編碼。

    圖片浮水印模板
    WatermarkConfig

    string

    是

    圖文浮水印的配置資訊（JSON 字串），包括浮水印顯示位置、浮水印效果等配置。圖片浮水印和文字浮水印的配置參數不同，參數結構詳情，請參見 WatermarkConfig 。

    { "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }
    FileUrl

    string

    否

    浮水印圖片檔案的 OSS 地址（不帶鑒權）。

    說明

    • 設定圖片浮水印模板（Type為Image）時，本參數必傳。

    • 您可以調用 CreateUploadAttachedMedia 介面將浮水印圖片上傳到ApsaraVideo for VOD中，上傳後返回參數FileURL的值可作為本參數的請求參數。

    http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png
    AppId

    string

    否

    應用 ID。預設取值：app-1000000。若已開通多應用體系，傳入應用 ID，可將浮水印模板添加到指定應用下。使用說明，請參見多應用體系。

    app-****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    25818875-5F78-4A*****F6-D7393642CA58
    WatermarkInfo

    object

    浮水印模板資訊。

    CreationTime

    string

    浮水印模板的建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2018-11-07T09:05:52Z
    Type

    string

    浮水印模板的類型。

    • Image：圖片浮水印模板。

    • Text：文字浮水印模板。

    Image
    IsDefault

    string

    是否是預設圖文浮水印模板：

    • Default：預設圖文浮水印模板。

    • NotDefault：非預設圖文浮水印模板。

    NotDefault
    FileUrl

    string

    浮水印檔案 URL（OSS 地址或 CDN 地址）。

    說明

    僅圖片浮水印模板會返回此參數。

    https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****
    WatermarkConfig

    string

    圖文浮水印的配置資訊（JSON 字串），包括浮水印顯示位置、浮水印效果等配置。圖片浮水印和文字浮水印的配置參數不同，參數結構詳情，請參見 WatermarkConfig 。

    { "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }
    Name

    string

    浮水印模板名稱。

    圖片浮水印模板
    WatermarkId

    string

    浮水印模板 ID。後續可使用該浮水印模板 ID 關聯到轉碼模板組，或對浮水印模板進行查詢、修改、刪除、設定預設浮水印模板等操作。

    9bcc8bfadb84*****109a2671d0df97

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-07T09:05:52Z",
    "Type": "Image",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\n      \"Width\": \"55\",\n      \"Height\": \"55\",\n      \"Dx\": \"9\",\n      \"Dy\": \"9\",\n      \"ReferPos\": \"BottomLeft\"\n}",
    "Name": "圖片浮水印模板",
    "WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。