文档

GetWatermark - 查询单个图文水印模板

更新时间:

调用GetWatermark通过水印模板ID查询单个图片水印模板或文字水印模板的配置信息,包括图片水印的位置、大小,展示时间,文字水印的内容、字体、颜色、位置等参数配置信息。

调试

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

授权信息

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

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

请求参数

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

需要查询的图文水印模板 ID,仅支持传入单个水印模板 ID。可通过如下方式获取:

  • 调用 AddWatermark 接口添加图文水印模板后会返回。
  • 调用 ListWatermark 接口查询图文水印模板列表后会返回。
9bcc8bfadb843f*****09a2671d0df97

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfoobject

图文水印模板信息。

CreationTimestring

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

2018-11-06T08:03:17Z
Typestring

水印模板的类型:

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

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

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

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

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

应用 ID。

app-****
WatermarkConfigstring

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

{"ReferPos": "BottomRight","Height": "55","Width": "55","Dx": "8","Dy": "8" }
Namestring

水印模板名称。

图片水印测试
WatermarkIdstring

水印模板 ID。

505e2e287ea*****ecfddd386d384

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-06T08:03:17Z",
    "Type": "Image",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-32*****f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/F85529C8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "AppId": "app-****",
    "WatermarkConfig": "{\"ReferPos\": \"BottomRight\",\"Height\": \"55\",\"Width\": \"55\",\"Dx\": \"8\",\"Dy\": \"8\" }",
    "Name": "图片水印测试",
    "WatermarkId": "505e2e287ea*****ecfddd386d384"
  }
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码错误信息HTTP 状态码说明
NoSuchResourceThe specified resource %s does not exist.404用户相关的资源数据不存在, %s 表示具体资源信息。
  • 本页导读 (1)