全部產品
Search
文件中心

ApsaraVideo Media Processing:SearchWaterMarkTemplate - 搜尋浮水印模板

更新時間:Feb 25, 2026

搜尋浮水印模板。

介面說明

本介面通過指定狀態搜尋浮水印模板,如不指定則預設搜尋全部模板。

QPS 限制

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

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mts:SearchWaterMarkTemplate

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

PageSize

integer

分頁查詢時設定的每頁大小。

  • 上限值:100

  • 預設值:10

10

PageNumber

integer

當前頁號。預設值:1

1

State

string

浮水印模板狀態。

  • All:表示所有,預設值。

  • Normal:表示正常。

  • Deleted:表示已刪除。

Normal

返回參數

名稱

類型

描述

樣本值

object

返回參數。

TotalCount

integer

總條數。

1

PageSize

integer

分頁大小。

10

RequestId

string

請求 ID。

FC029D04-8F47-57FF-A759-23383C15617D

PageNumber

integer

當前頁碼。

1

WaterMarkTemplateList

object

WaterMarkTemplate

array<object>

模板列表。

array<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.2

ReferPos

string

浮水印的位置。取值:

  • TopRight:右上。

  • TopLeft:左上。

  • BottomRight:右下。

  • BottomLeft:左下。

TopRight

State

string

浮水印模板的狀態。取值:

  • Normal:正常。

  • Deleted:已刪除。

Normal

Dx

string

水平位移量。單位:px。

100

Width

string

寬。單位:px。

8

Height

string

高。單位:px。

8

Timeline

object

動態浮水印。

Start

string

浮水印開始出現時間。

  • 單位:秒。

  • 預設值:0

0

Duration

string

浮水印期間。預設值:ToEND(直至視頻結束)。

ToEND

Name

string

浮水印模板名稱。

example-watermark

Dy

string

垂直位移量。單位:px。

100

Id

string

浮水印模板 ID。

88c6ca184c0e4578645b665e2a12****

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "FC029D04-8F47-57FF-A759-23383C15617D",
  "PageNumber": 1,
  "WaterMarkTemplateList": {
    "WaterMarkTemplate": [
      {
        "Type": "Image",
        "RatioRefer": {
          "Dx": "0.51",
          "Width": "0.36",
          "Height": "0.33",
          "Dy": "0.2"
        },
        "ReferPos": "TopRight",
        "State": "Normal",
        "Dx": "100",
        "Width": "8",
        "Height": "8",
        "Timeline": {
          "Start": "0",
          "Duration": "ToEND"
        },
        "Name": "example-watermark",
        "Dy": "100",
        "Id": "88c6ca184c0e4578645b665e2a12****"
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情