tencent cloud



Last updated: 2024-03-27 16:08:15

    1. API Description

    Domain name for API request: vod.tencentcloudapi.com.

    This API is used to query custom watermarking templates and supports paged queries by filters.

    A maximum of 100 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeWatermarkTemplates.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Type No String Watermark type filter. Valid values:
  • image: image watermark;
  • text: text watermark.
  • Offset No Integer Pagination offset. Default value: 0.
    Definitions.N No Array of Integer Unique ID filter of watermarking templates. Array length limit: 100.
    Limit No Integer Number of returned entries
  • Default value: 10;
  • Maximum value: 100.
  • 3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible entries.
    WatermarkTemplateSet Array of WatermarkTemplate List of watermarking template details.
    Note: this field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying watermark templates

    Input Example

    &<Common request parameters>

    Output Example

        "Response": {
            "TotalCount": 1,
            "WatermarkTemplateSet": {
                "Definition": 1001,
                "Type": "image",
                "Name": "Sample structure to be completed",
                "Comment": "Test template",
                "XPos": "10%",
                "YPos": "10%",
                "ImageTemplate": {
                    "ImageUrl": "http://1256768367.vod2.myqcloud.com/8b0dd2b5vodcq1256768367/4d27b39f5285890783754292994/aa.jpeg",
                    "Width": "80%",
                    "Height": "80%",
                    "RepeatType": "repeat"
                "TextTemplate": {
                    "FontType": "arial.ttf",
                    "FontSize": "16px",
                    "FontColor": "0xFF0000",
                    "FontAlpha": 1
                "CreateTime": "2018-10-01T10:00:00Z",
                "UpdateTime": "2018-10-01T10:00:00Z"
            "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"

    5. Developer Resources


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue.Definitions Invalid parameter: Definitions.
    InvalidParameterValue.Limit Invalid parameter: Limit.
    InvalidParameterValue.Type Incorrect Type parameter value.
    ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
    UnauthorizedOperation Unauthorized operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support