DescribeBlindWatermarkTemplates

Last updated: 2025-12-02 14:26:21Download PDF

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

This API is used to query a user-defined digital watermark template, and the pagination query is supported based on conditions.

A maximum of 20 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: DescribeBlindWatermarkTemplates.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
Definitions.N	No	Array of Integer	Filtering condition for the unique identifier of the digital watermark template. The array length cannot exceed 100.
Name	No	String	Filtering condition for the unique identifier of the digital watermark template. The length cannot exceed 64 characters.
Type	No	String	Digital watermark type. Valid values: blind-basic: basic copyright digital watermark; blind-nagra: NAGRA forensics watermark.
Offset	No	Integer	Pagination offset. The default value is 0.
Limit	No	Integer	Number of returned records. Default value: 10. Maximum value: 100.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of records that meet the filtering conditions.
BlindWatermarkTemplateSet	Array of BlindWatermarkTemplate	List of digital watermark template details.
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 a User-Defined Digital Watermark Template

This example shows you how to query a user-defined digital watermark template.

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBlindWatermarkTemplates
<Common request parameters>

{
    "Definitions": [
        10,
        20,
        30
    ],
    "Type": "blind-basic",
    "Offset": 0,
    "Limit": 10
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "BlindWatermarkTemplateSet": [
            {
                "Definition": 1001,
                "Type": "blind-basic",
                "Name": "Digital watermark template 1",
                "Comment": "Test template",
                "TextContent": "Text content",
                "CreateTime": "2018-10-01T10:00:00Z",
                "UpdateTime": "2018-10-01T10:00:00Z"
            }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameterValue.Definitions	Parameter error: Definitions.
InvalidParameterValue.Limit	Parameter error: Limit.
InvalidParameterValue.Type	Parameter error: incorrect `Type` value.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.