文档

ListWatermark - 查询图文水印模板列表

更新时间:

调用ListWatermark查询当前服务地域下已添加的所有图片水印模板和文字水印模板的配置信息,包括图片水印的位置、大小,展示时间,文字水印的内容、字体、颜色、位置等参数配置信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:ListWatermarkList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。默认取值:app-1000000

若已开通多应用体系,传入应用 ID,可查询指定应用下的图文水印模板;不传,则默认返回所有应用下的图文水印模板。使用说明,请参见多应用

app-****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfosobject []

水印模板信息。

CreationTimestring

水印模板的创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2018-11-07T09:05:52Z
Typestring

水印模板的类型。

  • Image:图片水印模板。
  • Text:文字水印模板。
Text
IsDefaultstring

是否是默认图文水印模板:

  • Default:默认图文水印模板。
  • NotDefault:非默认图文水印模板。
NotDefault
FileUrlstring

水印文件 URL(OSS 地址或 CDN 地址)。

说明 仅图片水印模板会返回此参数。
https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****
AppIdstring

应用 ID。

app-****
WatermarkConfigstring

图文水印的配置信息(JSON 字符串),包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同,参数结构详情,请参见 WatermarkConfig

{"FontColor": "Blue","FontSize": 80,"Content": "水印测试"}
Namestring

水印模板名称。

文字水印测试
WatermarkIdstring

水印模板 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\": \"水印测试\"}",
      "Name": "文字水印测试",
      "WatermarkId": "9bcc8bfadb843*****109a2671d0df97"
    }
  ]
}

错误码

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

  • 本页导读 (1)