调用AddWatermark添加水印数据。

说明 目前支持的图片水印格式包括静态(PNG)动态(GIF、APNG、MOV)

调试

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

请求参数

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

系统规定参数,取值:AddWatermark

Name String 水印

水印名称。只支持中英文、数字。

  • 长度不超过128个字节。
  • UTF-8编码。
Type String Text

水印类型:Image(图片,默认值)Text(文字)。

水印类型不同,WatermarkConfig内容不同。

WatermarkConfig String {"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}

水印显示位置、效果等配置(JSON字符串)。

不同的水印类型对应不同的WatermarkConfig内容。参数结构详情参考 WatermarkConfig

FileUrl String http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png

水印文件的oss地址。图片水印必传。

AppId String app-xxxx

应用ID。取值如:app-1000000,使用说明参考文档 多应用

说明 水印文件上传参见 CreateUploadAttachedMedia

返回数据

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

请求ID。

WatermarkInfo Struct

水印信息。

CreationTime String 2018-11-07T09:05:52Z

水印创建时间。

FileUrl String https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=XXXXXXX&Signature=gmf1eYMoDVg%2BHQCb4UGozBW4xZo%3D

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

IsDefault String NotDefault

是否是默认水印:Default(默认水印)NotDefault(非默认水印)

Name String 文字水印测试

水印名称。

Type String Text

水印类型。

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

((JSON字符串))水印显示位置、效果等配置信息:文字水印、图片水印。

WatermarkId String 9bcc8bfadb84*****109a2671d0df97

水印ID。

说明 下述请求示例中的“公共请求参数”详情,参见公共参数说明文档

示例

请求示例

http(s)://[Endpoint]/?Action=AddWatermark
&Name=水印
&Type=Text
&WatermarkConfig={"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}
&<公共请求参数>

正常返回示例

XML 格式

<AddWatermarkResponse>
      <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
      <WatermarkInfo>
            <Name>图片水印测试</Name>
            <CreationTime>2018-11-06T08:03:17Z</CreationTime>
            <WatermarkId>9bcc8bfadb84*****109a2671d0df97</WatermarkId>
            <FileUrl>https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&amp;OSSAccessKeyId=XXXXXXX&amp;Signature=gmf1eYMoDVg%2BHQCb4UGozBW4xZo%3D</FileUrl>
            <IsDefault>NotDefault</IsDefault>
            <Type>Image</Type>
            <WatermarkConfig>
                  <ReferPos>BottomRight</ReferPos>
                  <Type>Image</Type>
                  <Height>55</Height>
                  <Width>55</Width>
                  <Dx>8</Dx>
                  <Dy>8</Dy>
            </WatermarkConfig>
      </WatermarkInfo>
</AddWatermarkResponse>

JSON 格式

{
    "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
    "WatermarkInfo":{
        "Name": "图片水印测试",
        "CreationTime": "2018-11-06T08:03:17Z",
        "WatermarkId": "9bcc8bfadb84*****109a2671d0df97",
        "FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=XXXXXXX&Signature=gmf1eYMoDVg%2BHQCb4UGozBW4xZo%3D",
        "IsDefault": "NotDefault",
        "Type": "Image",
        "WatermarkConfig": {
            "ReferPos": "BottomRight",
            "Type": "Image",
            "Height": "55",
            "Width": "55",
            "Dx": "8",
            "Dy": "8"
        }
    }
}

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

NoSuchResource

The specified resource %s does not exist.

404

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

SDK示例

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