调用本接口查询当前服务地域下已添加的所有图片水印模板和文字水印模板的配置信息,包括图片水印的位置、大小,展示时间,文字水印的内容、字体、颜色、位置等参数配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vod:ListWatermark |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppId |
string |
否 |
应用 ID。默认取值:app-1000000。 若已开通多应用体系,传入应用 ID,可查询指定应用下的图文水印模板;不传,则默认返回所有应用下的图文水印模板。使用说明,请参见多应用。 |
app-**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
25818875-5F78-4A*****F6-D7393642CA58 |
| WatermarkInfos |
array<object> |
水印模板信息。 |
|
|
object |
|||
| CreationTime |
string |
水印模板的创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2018-11-07T09:05:52Z |
| Type |
string |
水印模板的类型。
|
Text |
| IsDefault |
string |
是否是默认图文水印模板:
|
NotDefault |
| FileUrl |
string |
水印文件 URL(OSS 地址或 CDN 地址)。 说明
仅图片水印模板会返回此参数。 |
https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB**** |
| AppId |
string |
应用 ID。 |
app-**** |
| WatermarkConfig |
string |
图文水印的配置信息(JSON 字符串),包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同,参数结构详情,请参见 WatermarkConfig 。 |
{"FontColor": "Blue","FontSize": 80,"Content": " watermark test"} |
| Name |
string |
水印模板名称。 |
Text watermark test |
| WatermarkId |
string |
水印模板 ID。 |
9bcc8bfadb843*****109a2671d0df97 |
示例
正常返回示例
JSON格式
{
"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
"WatermarkInfos": [
{
"CreationTime": "2018-11-07T09:05:52Z",
"Type": "Text",
"IsDefault": "NotDefault",
"FileUrl": "https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****",
"AppId": "app-****",
"WatermarkConfig": "{\"FontColor\": \"Blue\",\"FontSize\": 80,\"Content\": \" watermark test\"}",
"Name": "Text watermark test",
"WatermarkId": "9bcc8bfadb843*****109a2671d0df97"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。