调用QueryWaterMarkTemplateList查询水印模板。
使用说明
本接口一次最多查询10个水印模板。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryWaterMarkTemplateList |
操作接口名,系统规定参数,取值: QueryWaterMarkTemplateList。 |
WaterMarkTemplateIds | String | 是 | 3780bd69b2b74540bc7b1096f564**** |
需要查询的水印模板ID,可以通过MPS控制台>全局设置>水印模板获取。最多一次查10个,半角逗号(,)分隔。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 17079AF5-6276-51A9-B755-D26594C93F3C |
请求ID。 |
NonExistWids | Array of String | 72dfa5e679ab4be9a3ed9974c736**** |
不存在的水印模板列表,无数据时该参数不返回。 |
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.4 |
水印图片相对输出视频的垂直偏移量。默认值: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 | 10 |
水印持续时间。默认值:ToEND(直至视频结束)。 |
Name | String | example-watermark |
水印模板名称。 |
Dy | String | 100 |
垂直偏移量。单位:px。 |
Id | String | 3780bd69b2b74540bc7b1096f564**** |
水印模板ID。 |
示例
请求示例
http(s)://mts.cn-shanghai.aliyuncs.com/?Action=QueryWaterMarkTemplateList
&WaterMarkTemplateIds=3780bd69b2b74540bc7b1096f564****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<QueryWaterMarkTemplateListResponse>
<RequestId>17079AF5-6276-51A9-B755-D26594C93F3C</RequestId>
<NonExistWids>72dfa5e679ab4be9a3ed9974c736****</NonExistWids>
<WaterMarkTemplateList>
<Type>Image</Type>
<RatioRefer>
<Dx>0.51</Dx>
<Width>0.36</Width>
<Height>0.33</Height>
<Dy>0.4</Dy>
</RatioRefer>
<ReferPos>TopRight</ReferPos>
<State>Normal</State>
<Dx>100</Dx>
<Width>8</Width>
<Height>8</Height>
<Timeline>
<Start>0</Start>
<Duration>10</Duration>
</Timeline>
<Name>example-watermark</Name>
<Dy>100</Dy>
<Id>3780bd69b2b74540bc7b1096f564****</Id>
</WaterMarkTemplateList>
</QueryWaterMarkTemplateListResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "17079AF5-6276-51A9-B755-D26594C93F3C",
"NonExistWids" : [ "72dfa5e679ab4be9a3ed9974c736****" ],
"WaterMarkTemplateList" : [ {
"Type" : "Image",
"RatioRefer" : {
"Dx" : "0.51",
"Width" : "0.36",
"Height" : "0.33",
"Dy" : "0.4"
},
"ReferPos" : "TopRight",
"State" : "Normal",
"Dx" : "100",
"Width" : "8",
"Height" : "8",
"Timeline" : {
"Start" : "0",
"Duration" : "10"
},
"Name" : "example-watermark",
"Dy" : "100",
"Id" : "3780bd69b2b74540bc7b1096f564****"
} ]
}
错误码
访问错误中心查看更多错误码。