All Products
Search
Document Center

ApsaraVideo VOD:GetWatermark

Last Updated:May 22, 2024

Queries information about an watermark.

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:GetWatermarkRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
WatermarkIdstringYes

The ID of the watermark.

9bcc8bfadb843f*****09a2671d0df97

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 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. Valid values:

  • Image
  • Text
Text
IsDefaultstring

Indicates whether the watermark is the default one. 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-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 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.

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

The name of the watermark.

image watermark test
WatermarkIdstring

The ID of the watermark.

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.