调用SearchWaterMarkTemplate搜索水印模板。
使用说明
本接口通过指定状态搜索水印模板,如不指定则默认搜索全部模板。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SearchWaterMarkTemplate |
操作接口名,系统规定参数,取值: SearchWaterMarkTemplate。 |
PageSize | Long | 否 | 10 |
分页查询时设置的每页大小。
|
PageNumber | Long | 否 | 1 |
当前页号。默认值:1。 |
State | String | 否 | Normal |
水印模板状态。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Long | 1 |
总条数。 |
PageSize | Long | 10 |
分页大小。 |
RequestId | String | FC029D04-8F47-57FF-A759-23383C15617D |
请求ID。 |
PageNumber | Long | 1 |
当前页码。 |
WaterMarkTemplateList | Array of WaterMarkTemplate |
模板列表。 |
|
WaterMarkTemplate | |||
Type | String | Image |
水印类型。取值:
说明 目前仅支持Image。
|
RatioRefer | Object |
取值为百分比是参考的边。当Height、Width、Dx、Dy的取值处于(0,1)时,这个百分比是参考哪个边得到的(按顺序):
|
|
Dx | String | 0.51 |
水印图片相对输出视频的水平偏移量。默认值:0(无偏移)。 值有两种形式:
|
Width | String | 0.36 |
输出视频上水印图片宽。值有两种形式:
|
Height | String | 0.33 |
输出视频上水印图片高。值有两种形式:
|
Dy | String | 0.2 |
水印图片相对输出视频的垂直偏移量。默认值:0(无偏移)。值有两种形式:
|
ReferPos | String | TopRight |
水印的位置。取值:
|
State | String | Normal |
水印模板的状态。取值:
|
Dx | String | 100 |
水平偏移量。单位:px。 |
Width | String | 8 |
宽。单位:px。 |
Height | String | 8 |
高。单位:px。 |
Timeline | Object |
动态水印。 |
|
Start | String | 0 |
水印开始出现时间。
|
Duration | String | ToEND |
水印持续时间。默认值:ToEND(直至视频结束)。 |
Name | String | example-watermark |
水印模板名称。 |
Dy | String | 100 |
垂直偏移量。单位:px。 |
Id | String | 88c6ca184c0e4578645b665e2a12**** |
水印模板ID。 |
示例
请求示例
http(s)://mts.cn-shanghai.aliyuncs.com/?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>FC029D04-8F47-57FF-A759-23383C15617D</RequestId>
<PageNumber>1</PageNumber>
<WaterMarkTemplateList>
<Type>Image</Type>
<RatioRefer>
<Dx>0.51</Dx>
<Width>0.36</Width>
<Height>0.33</Height>
<Dy>0.2</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" : "FC029D04-8F47-57FF-A759-23383C15617D",
"PageNumber" : 1,
"WaterMarkTemplateList" : [ {
"Type" : "Image",
"RatioRefer" : {
"Dx" : "0.51",
"Width" : "0.36",
"Height" : "0.33",
"Dy" : "0.2"
},
"ReferPos" : "TopRight",
"State" : "Normal",
"Dx" : "100",
"Width" : "8",
"Height" : "8",
"Timeline" : {
"Start" : "0",
"Duration" : "ToEND"
},
"Name" : "example-watermark",
"Dy" : "100",
"Id" : "88c6ca184c0e4578645b665e2a12****"
} ]
}
错误码
访问错误中心查看更多错误码。