edit-icon download-icon

SearchWaterMarkTemplate

Last Updated: Mar 15, 2018

Description

The SearchWaterMarkTemplate API searches for watermark templates in the specified state.

Request parameters

Parameter Type Required or not Description
Action String Yes API of the action, system required parameter. Set this parameter to SearchWaterMarkTemplate.
PageNumber Long No Current page number, which starts from 1. The default value is 1.
PageSize Long No When querying by page, this parameter indicates the size of each page. The default value is 10, and the maximum value is 100.
State String No Watermark template status, which has the following options: All indicates all states, Normal indicates normal templates, and Deleted indicates deleted templates. The default value is All.

Return parameters

Name Type Description
WaterMarkTemplateList AliyunWaterMarkTemplate[ ] List of watermark templates

Example

Request example

  1. http://mts.cn-hangzhou.aliyuncs.com/?Action=SearchWaterMarkTemplate&<Public parameter>

Return example

XML

  1. <SearchWaterMarkTemplateResponse>
  2. <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
  3. <TotalCount>1</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>10</PageSize>
  6. <WaterMarkTemplateList list="true">
  7. <WaterMarkTemplate>
  8. <Id>88c6ca184c0e47098a5b665e2a126797</Id>
  9. <Name>example-watermark</Name>
  10. <Width>10</Width>
  11. <Height>30</Height>
  12. <Dx>10</Dx>
  13. <Dy>5</Dy>
  14. <ReferPos>TopRight</ReferPos>
  15. <Type>Image</Type>
  16. <State>Normal</State>
  17. </WaterMarkTemplate>
  18. </WaterMarkTemplateList>
  19. </SearchWaterMarkTemplateResponse>

JSON

  1. {
  2. "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  3. "TotalCount": 100,
  4. "PageNumber": 1,
  5. "PageSize": 10,
  6. "WaterMarkTemplateList": {
  7. "WaterMarkTemplate": [{
  8. "Id": "88c6ca184c0e47098a5b665e2a126797",
  9. "Name": "example-watermark",
  10. "Width": "10",
  11. "Height": "30",
  12. "Dx": "10",
  13. "Dy": "5",
  14. "ReferPos": "TopRight",
  15. "Type": "Image",
  16. "State": "Normal"
  17. }]
  18. }
  19. }
Thank you! We've received your feedback.