调用GetWatermark查询单个水印数据。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetWatermark

系统规定参数。取值:GetWatermark

WatermarkId String 9bcc8bfadb843f*****09a2671d0df97

水印ID。

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4A*****F6-D7393642CA58

请求ID。

WatermarkInfo Object

水印数据。

CreationTime String 2018-11-06T08:03:17Z

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

Type String Text

水印类型:

  • Image:图片。
  • Text:文字。
IsDefault String NotDefault

是否是默认水印:

  • Default:默认水印。
  • NotDefault:非默认水印。
FileUrl String https://outin-32*****f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/F85529C8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****

水印文件的URL(OSS地址或CDN地址),文字水印没有文件地址信息。

AppId String app-****

应用ID。

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

(JSON格式)水印显示位置、效果等配置信息:文字水印、图片水印。参数构造详情,请参见WatermarkConfig

Name String 图片水印测试

水印名称。

WatermarkId String 505e2e287ea*****ecfddd386d384

水印ID。

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=GetWatermark
&WatermarkId=9bcc8bfadb843f*****09a2671d0df97
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

NoSuchResource

The specified resource %s does not exist.

404

用户相关的资源数据不存在, %s表示具体资源信息。

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: