全部產品
Search

搜尋本產品

    ApsaraVideo VOD：ListWatermark

    文件中心

    ApsaraVideo VOD：ListWatermark

    更新時間：Jul 21, 2026

    呼叫本介面查詢目前服務地域下已新增的所有圖片浮水印範本和文字浮水印範本的設定資訊，包括圖片浮水印的位置、大小、顯示時間，以及文字浮水印的內容、字型、顏色、位置等參數設定資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vod:ListWatermark

    list

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    AppId

    string

    否

    應用程式 ID。預設取值：app-1000000。

    若已開通多應用程式體系，傳入應用程式 ID，可查詢指定應用程式下的圖文浮水印範本；若不傳入，則預設返回所有應用程式下的圖文浮水印範本。使用說明，請參見多應用。

    app-****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

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

    array<object>

    浮水印範本資訊。

    object

    CreationTime

    string

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

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

    string

    浮水印範本的類型。

    • Image：圖片浮水印範本。

    • Text：文字浮水印範本。

    Text
    IsDefault

    string

    是否為預設圖文浮水印範本：

    • Default：預設圖文浮水印範本。

    • NotDefault：非預設圖文浮水印範本。

    NotDefault
    FileUrl

    string

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

    說明

    僅圖片浮水印範本會返回此參數。

    https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****
    AppId

    string

    應用程式 ID。

    app-****
    WatermarkConfig

    string

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

    {"FontColor": "Blue","FontSize": 80,"Content": " watermark test"}
    Name

    string

    浮水印範本名稱。

    Text watermark test
    WatermarkId

    string

    浮水印範本 ID。

    9bcc8bfadb843*****109a2671d0df97

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfos": [
    {
      "CreationTime": "2018-11-07T09:05:52Z",
      "Type": "Text",
      "IsDefault": "NotDefault",
      "FileUrl": "https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****",
      "AppId": "app-****",
      "WatermarkConfig": "{\"FontColor\": \"Blue\",\"FontSize\": 80,\"Content\": \"水印测试\"}",
      "Name": "文字水印测试",
      "WatermarkId": "9bcc8bfadb843*****109a2671d0df97"
    }
  ]
}

    錯誤碼

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

    變更歷史

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