全部產品
Search

搜尋本產品

    ApsaraVideo Media Processing：UpdateWaterMarkTemplate - 更新浮水印模版

    文件中心

    ApsaraVideo Media Processing：UpdateWaterMarkTemplate - 更新浮水印模版

    更新時間：Feb 25, 2026

    更新指定浮水印模板的名稱、配置。

    介面說明

    • 本介面通過指定浮水印模板 ID 對浮水印模板的名稱、配置等資訊進行更新。

    • 如果有狀態為“已提交”的作業指定使用該浮水印模板，則相應的浮水印模板不能被更新。

    QPS 限制

    本介面的單使用者 QPS 限制為 100 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。更多資訊，請參見 QPS 限制。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mts:UpdateWaterMarkTemplate

    update

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    WaterMarkTemplateId

    string

    是

    需要更新的浮水印模板 ID，可以通過 MPS 控制台>全域設定>浮水印模板擷取。

    3780bd69b2b74540bc7b1096f564****
    Name

    string

    是

    更新後的模板名稱。支援中英文、數字等，最大長度 128 位元組。

    example-watermark-****
    Config

    string

    是

    更新後的浮水印模板配置。JSON 對象，更多資訊請參見浮水印模板配置詳情。

    {"Width":"10","Height":"30","Dx":"10","Dy":"5","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數。

    WaterMarkTemplate

    object

    浮水印模板詳細資料。

    Type

    string

    浮水印類型。取值：

    • Image：圖片。

    • Text：文字。

    說明

    目前僅支援 Image 類型。

    Image
    RatioRefer

    object

    取值為百分比是參考的邊。當 Height、Width、Dx、Dy 的取值處於（0，1）時，得到這個百分比參考的邊（按順序）：

    • Width：寬。

    • Height：高。

    • Long：長邊。

    • Short：短邊。

    Dx

    string

    浮水印圖片相對輸出視頻的水平位移量。預設值：0（無位移）。值有兩種形式：

    • 整數型：代表位移像素，絕對位置，單位：px。

    • 小數型：代表水平位移量與輸出解析度寬的比率，相對比例，按照視頻尺寸變化，支援 4 位小數，如 0.9999，超出部分系統自動丟棄。

    0.51
    Width

    string

    輸出視頻上浮水印圖片寬。值有兩種形式：

    • 整數型：代表浮水印圖片寬的像素值，絕對位置，單位：px。

    • 小數型：代表相對輸出視頻解析度寬的比率，相對比例，按照視頻尺寸變動，支援 4 位小數，如 0.9999，超出部分系統自動丟棄。

    0.36
    Height

    string

    輸出視頻上浮水印圖片高。值有兩種形式：

    • 整數型：代表浮水印圖片高的像素值，絕對位置，單位：px。

    • 小數型：代表相對輸出視頻解析度高的比率，相對比例，按照視頻尺寸變動，支援 4 位小數，如 0.9999，超出部分系統自動丟棄。

    0.33
    Dy

    string

    浮水印圖片相對輸出視頻的垂直位移量。預設值：0（無位移）。值有兩種形式：

    • 整數型：代表位移像素，絕對位置，單位：px。

    • 小數型：代表垂直位移量與輸出解析度高的比率，相對比例，按照視頻尺寸變動，支援 4 位小數，如 0.9999，超出部分系統自動丟棄。

    0.28
    ReferPos

    string

    浮水印的位置。取值：

    • TopRight：右上。

    • TopLeft：左上。

    • BottomRight：右下。

    • BottomLeft：左下。

    TopRight
    State

    string

    浮水印模板的狀態。此處預設為 Normal（正常）。

    Normal
    Dx

    string

    水平位移量。單位：px。

    10
    Width

    string

    浮水印圖片寬度。單位：px。

    10
    Height

    string

    浮水印圖片高度。單位：px。

    30
    Timeline

    object

    動態浮水印。

    Start

    string

    浮水印開始出現時間。

    • 單位：秒（s）。

    • 預設值：0。

    0
    Duration

    string

    浮水印期間。預設值：ToEND（直至視頻結束）。

    10
    Name

    string

    浮水印模板名稱。

    example-watermark-****
    Dy

    string

    垂直位移量。單位：px。

    5
    Id

    string

    浮水印模板 ID。建議您儲存此 ID 便於後續調用相關介面時使用。

    3780bd69b2b74540bc7b1096f564****
    RequestId

    string

    請求 ID。

    E558894E-40D9-57C6-B5CC-0F5CDF23614E

    樣本

    正常返回樣本

    JSON格式

    {
  "WaterMarkTemplate": {
    "Type": "Image",
    "RatioRefer": {
      "Dx": "0.51",
      "Width": "0.36",
      "Height": "0.33",
      "Dy": "0.28"
    },
    "ReferPos": "TopRight",
    "State": "Normal",
    "Dx": "10",
    "Width": "10",
    "Height": "30",
    "Timeline": {
      "Start": "0",
      "Duration": "10"
    },
    "Name": "example-watermark-****",
    "Dy": "5",
    "Id": "3780bd69b2b74540bc7b1096f564****"
  },
  "RequestId": "E558894E-40D9-57C6-B5CC-0F5CDF23614E"
}

    錯誤碼

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

    變更歷史

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