调用SearchWaterMarkTemplate接口搜索指定状态的水印模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SearchWaterMarkTemplate

操作接口名,系统规定参数,取值: SearchWaterMarkTemplate

PageSize Long 10

分页查询时设置的每页大小。

  • 上限值:100
  • 默认值:10
PageNumber Long 1

当前页号。默认值:1

State String Normal

水印模板状态。

  • All:表示所有,默认值。
  • Normal:表示正常。
  • Deleted:表示已删除。

返回数据

名称 类型 示例值 描述
TotalCount Long 1

总条数。

PageSize Long 10

分页大小。

RequestId String 25818875-5F78-4A-7845F6-D7393642****

请求ID。

PageNumber Long 1

当前页码。

WaterMarkTemplateList Array of WaterMarkTemplate

模板列表。

WaterMarkTemplate
Type String Image

水印类型。取值:Image(图片)、Text(文本)。

说明 目前仅支持Image
RatioRefer Object

百分比参考。当Height、Width、Dx、Dy 是 (0, 1) 时,参考下列取值百分比:

  • Width :宽。
  • Height: 高。
  • Long :长边。
  • Short: 短边。
Dx String 100

水平偏移量。

  • 取值范围:[-4096,4096]
  • 单位:px。
Width String 8

宽。

  • 取值范围:[8,4096]
  • 单位:px。
Height String 8

高。

  • 取值范围:[8,4096]
  • 单位:px。
Dy String 100

垂直偏移量。

  • 取值范围:[-4096,4096]
  • 单位:px。
ReferPos String TopRight

水印的位置。取值:TopRight、TopLeft、BottomRight、BottomLeft。

State String Normal

水印模板的状态。取值:

  • Normal:正常。
  • Deleted:已删除。
Dx String 100

水平偏移量。

  • 取值范围:[-4096,4096]
  • 单位:px。
Width String 8

宽。

  • 取值范围:[8,4096]
  • 单位:px。
Height String 8

高。

  • 取值范围:[8,4096]
  • 单位:px。
Timeline Object

动态水印。

Start String 0

水印开始出现时间。

  • 单位:秒。
  • 取值范围:数字
  • 默认值:0
Duration String ToEND

水印持续时间。

  • 取值范围:[数字,ToEND]
  • 默认值:ToEND
Name String example-watermark

水印模板名称。

Dy String 100

垂直偏移量。

  • 取值范围:[-4096,4096]
  • 单位:px。
Id String 88c6ca184c0e4578645b665e2a12****

水印模板ID。

示例

请求示例

http(s)://[Endpoint]/?Action=SearchWaterMarkTemplate
&PageSize=10
&PageNumber=1
&State=Normal
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SearchWaterMarkTemplateResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>25818875-5F78-4A-7845F6-D7393642****</RequestId>
    <PageNumber>1</PageNumber>
    <WaterMarkTemplateList>
        <Type>Image</Type>
        <RatioRefer>
            <Dx>100</Dx>
            <Width>8</Width>
            <Height>8</Height>
            <Dy>100</Dy>
        </RatioRefer>
        <ReferPos>TopRight</ReferPos>
        <State>Normal</State>
        <Dx>100</Dx>
        <Width>8</Width>
        <Height>8</Height>
        <Timeline>
            <Start>0</Start>
            <Duration>ToEND</Duration>
        </Timeline>
        <Name>example-watermark</Name>
        <Dy>100</Dy>
        <Id>88c6ca184c0e4578645b665e2a12****</Id>
    </WaterMarkTemplateList>
</SearchWaterMarkTemplateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "25818875-5F78-4A-7845F6-D7393642****",
  "PageNumber" : 1,
  "WaterMarkTemplateList" : [ {
    "Type" : "Image",
    "RatioRefer" : {
      "Dx" : "100",
      "Width" : "8",
      "Height" : "8",
      "Dy" : "100"
    },
    "ReferPos" : "TopRight",
    "State" : "Normal",
    "Dx" : "100",
    "Width" : "8",
    "Height" : "8",
    "Timeline" : {
      "Start" : "0",
      "Duration" : "ToEND"
    },
    "Name" : "example-watermark",
    "Dy" : "100",
    "Id" : "88c6ca184c0e4578645b665e2a12****"
  } ]
}

错误码

访问错误中心查看更多错误码。