Domain name for API request: mps.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.
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: 2019-06-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
Definitions.N | No | Array of Integer | Unique ID filter of watermarking templates. Array length limit: 100. |
Type | No | String | Watermark type filter. Valid values: |
Offset | No | Integer | Paging offset. Default value: 0. |
Limit | No | Integer | Number of returned entries |
Name | No | String | Filter condition for watermark template identifiers, with a length limit of 64 characters. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of eligible entries. |
WatermarkTemplateSet | Array of WatermarkTemplate | List of watermarking 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. |
https://mps.tencentcloudapi.com/?Action=DescribeWatermarkTemplates
&Definitions.0=1001
&Offset=0
&Limit=20
&<Common request parameters>
{
"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.vts2.myqcloud.com/8b0dd2b5vtscq1256768367/4d27b39f5285890783754292994/aa.jpeg",
"Width": "80%",
"Height": "80%",
"RepeatType": "repeat"
},
"TextTemplate": {
"FontType": "arial.ttf",
"FontSize": "16px",
"FontColor": "0xFF0000",
"FontAlpha": 1
},
"SvgTemplate": {
"Width": "10W%",
"Height": "0px"
},
"CoordinateOrigin": "topLeft",
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z"
}
],
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?