All Products
Search
Document Center

ApsaraVideo VOD:ListWatermark

Last Updated:Feb 08, 2023

Queries watermarks.

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:ListWatermarkList
  • VOD
    acs:vod:*:{#accountId}:*/*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringNo

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

app-****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Details about the watermarks.

object
CreationTimestring

The time when the watermark 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. Valid values:

  • Image
  • Text
Text
IsDefaultstring

Indicates whether the default watermark was used. Valid values:

  • Default
  • NotDefault
NotDefault
FileUrlstring

The Object Storage Service (OSS) URL or CDN URL of the watermark file. A text watermark does not have a file URL.

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 such as the position and effect about the text watermark or image watermark. The value is a JSON string. For more information about the data structure, see the "WatermarkConfig: specifies the watermark configurations" section of the Parameters for media processing topic.

{"FontColor": "Blue","FontSize": 80,"Content": "Watermark testing"}
Namestring

The name of the watermark.

Text watermark testing
WatermarkIdstring

The ID of the watermark.

9bcc8bfadb843*****109a2671d0df97

Example

Normal return example

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\": \"Watermark testing\"}\n",
      "Name": "Text watermark testing\n",
      "WatermarkId": "9bcc8bfadb843*****109a2671d0df97"
    }
  ]
}

Error codes

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