GetWatermark - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the configurations of an image or text watermark template based on tits 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vod:GetWatermark	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WatermarkId	string	Yes	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfo	object	The information about the watermark template.
CreationTime	string	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
Type	string	The type of the watermark template. Valid values: Image: image watermark template Text: text watermark template	Text
IsDefault	string	Indicates whether the watermark template is the default one. Valid values: Default NotDefault	NotDefault
FileUrl	string	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**
AppId	string	The ID of the application.	app-****
WatermarkConfig	string	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" }
Name	string	The name of the watermark template.	image watermark test
WatermarkId	string	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 code	Error message	HTTP status code	Description
NoSuchResource	The specified resource %s does not exist.	404	The error message returned because the user-related resource does not exist. %s indicates the specific resource information.