All Products
Search
Document Center

ApsaraVideo VOD:GetWatermark

Last Updated:Jul 19, 2024

Queries the information about an image or text watermark based on the watermark template ID. You can call this operation to obtain information such as the position, size, and display time of an image watermark or the content, position, font, and font color of a text watermark.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
WatermarkIdstringYes

The ID of the watermark template. You can specify only one watermark template ID. You can obtain the ID by using one of the following methods:

  • Obtain the watermark template ID from the response to the AddWatermark operation that you call to create a watermark template.
  • Obtain the watermark template ID from the response to the ListWatermark operation that you call to query all watermarks within your account.
9bcc8bfadb843f*****09a2671d0df97

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The information about the watermark template.

CreationTimestring

The time when the watermark template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2018-11-06T08:03:17Z
Typestring

The type of the watermark template. Valid values:

  • Image: image watermark template
  • Text: text watermark template
Text
IsDefaultstring

Indicates whether the watermark template is the default one. Valid values:

  • Default
  • NotDefault
NotDefault
FileUrlstring

The URL of the watermark file. The URL is an Object Storage Service (OSS) URL or an Alibaba Cloud CDN URL.

Note This parameter is returned only for image watermark templates.
https://outin-32*****f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/F85529C8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****
AppIdstring

The ID of the application.

app-****
WatermarkConfigstring

The configuration information of the watermark such as the display position and special effects. The value is a JSON string. The configuration parameters for image and text watermarks are different. For more information about the parameter structure, see WatermarkConfig .

{"ReferPos": "BottomRight","Height": "55","Width": "55","Dx": "8","Dy": "8" }
Namestring

The name of the watermark template.

image watermark test
WatermarkIdstring

The ID of the watermark template.

505e2e287ea*****ecfddd386d384

Examples

Sample success responses

JSONformat

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-06T08:03:17Z",
    "Type": "Text",
    "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": "image watermark test",
    "WatermarkId": "505e2e287ea*****ecfddd386d384"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Common errors

The following table describes the common errors that this operation can return.

Error codeError messageHTTP status codeDescription
NoSuchResourceThe specified resource %s does not exist.404The error message returned because the user-related resource does not exist. %s indicates the specific resource information.