All Products
Search
Document Center

ApsaraVideo VOD:AddWatermark

Last Updated:Nov 09, 2022

Adds a watermark.

Operation Description

ApsaraVideo VOD supports static image watermarks such as PNG files and dynamic image watermarks such as GIF, APNG, and MOV files.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:AddWatermarkWrite
  • VOD
    acs:vod:*:{#accountId}:*/*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
TypestringYes

The type of the watermark. Valid values:

  • Image: This is the default value.
  • Text
Text
NamestringYes

The name of the watermark. Only letters and digits are supported.

  • The name can be up to 128 bytes in length.
  • The value must be encoded in UTF-8.
watermark
WatermarkConfigstringYes

The configurations such as the position and effect of the text watermark or image watermark. The value is a JSON-formatted string.

NoteThe value of this parameter varies with the watermark type. For more information about the data structure, see the "WatermarkConfig" section of the Media processing parameters topic.
{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}
FileUrlstringNo

The Object Storage Service (OSS) URL of the watermark file. You must set this parameter if you add image watermarks.

http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png
AppIdstringNo

The ID of the application. Default value: app-1000000. For more information, see Overview.

app-****
NoteFor more information about how to upload a watermark file, see CreateUploadAttachedMedia.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The information about the watermark.

CreationTimestring

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

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

The type of the watermark. Valid values:

  • Image: This is the default value.
  • Text
Text
IsDefaultstring

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

  • Default: The watermark is the default one.
  • NotDefault: The watermark is not the default one.
NotDefault
FileUrlstring

The OSS URL or Content Delivery Network (CDN) URL of the watermark file. A text watermark does not have a file URL.

https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****
WatermarkConfigstring

The configurations such as the position and effect of the text watermark or image watermark. The value is a JSON-formatted string.

NoteThe value of this parameter varies with the watermark type. For more information about the data structure, see the "WatermarkConfig" section of the Media processing parameters topic.
{"FontColor": "Blue","FontSize": 80, "Content": "watermark test" }
Namestring

The name of the watermark.

text watermark test
WatermarkIdstring

The ID of the watermark.

9bcc8bfadb84*****109a2671d0df97

Example

Normal return example

JSONFormat

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-07T09:05:52Z",
    "Type": "Text",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\"FontColor\": \"Blue\",\"FontSize\": 80, \"Content\": \"watermark test\" }",
    "Name": " text watermark test",
    "WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
  }
}

Error codes

For a list of error codes, visit the API error center.

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.