All Products
Search
Document Center

ApsaraVideo VOD:ListWatermark

Last Updated:Sep 26, 2024

Queries the configuration information about all image and text watermark templates in a region. You can call this operation to obtain information such as the position, size, and display time of image watermarks or the content, position, font, and font color of text watermarks.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:ListWatermarklist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringNo

The ID of the application. Default value: app-1000000.

If you have activated the multi-application service, specify the ID of the application to query all image and text watermark templates in the specified application. If you leave this parameter empty, image and text watermark templates in all applications are queried. For more information, see Overview .

app-****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfosarray<object>

The information about the watermark template.

WatermarkInfoobject
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-07T09:05:52Z
Typestring

The type of the watermark template.

  • 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-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****
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 .

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

The name of the watermark template.

testName
WatermarkIdstring

The ID of the watermark template.

9bcc8bfadb843*****109a2671d0df97

Examples

Sample success responses

JSONformat

{
  "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\": \"test watermark\"}",
      "Name": "testName",
      "WatermarkId": "9bcc8bfadb843*****109a2671d0df97"
    }
  ]
}

Error codes

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