调用ListWatermark查询用户水印数据列表。

调试

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

请求参数

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

系统规定参数,取值:ListWatermark

PageSize Integer 10

列表每页大小。

PageNo Integer 1

当前页码。

AppId String app-xxxxx

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

返回数据

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

请求ID。

WatermarkInfos Array of WatermarkInfo

水印数据列表。

AppId String app-xxxxx

应用ID。

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

水印创建时间。

FileUrl String https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=XXXXXX&Signature=gmf1eYMoDVg%2BHQCb4UGozBW4xZo%3D

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

IsDefault String NotDefault

是否是默认水印。

Name String 文字水印测试

水印名称。

Type String Text

水印类型:Image(图片)Text(文字)

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

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

WatermarkId String 9bcc8bfadb843*****109a2671d0df97

水印ID。

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListWatermark
&<公共请求参数>

正常返回示例

XML 格式

<ListWatermarkResponse>
	  <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
	  <WatermarkInfos>
		    <Name>文字水印测试</Name>
		    <CreationTime>2018-11-07T09:05:52Z</CreationTime>
		    <IsDefault>NotDefault</IsDefault>
		    <Type>Text</Type>
		    <WatermarkId>9bcc8bfadb843*****109a2671d0df97</WatermarkId>
		    <WatermarkConfig>
			      <FontColor>Blue</FontColor>
			      <FontSize>80</FontSize>
			      <Content>水印测试</Content>
		    </WatermarkConfig>
	  </WatermarkInfos>
</ListWatermarkResponse>

JSON 格式

{
    "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
    "WatermarkInfos": [
        {
            "Name": "文字水印测试",
            "CreationTime": "2018-11-07T09:05:52Z",
            "IsDefault": "NotDefault",
            "Type": "Text",
            "WatermarkId": "9bcc8bfadb843*****109a2671d0df97",
            "WatermarkConfig": {
                "FontColor": "Blue",
                "FontSize": 80,
                "Content": "水印测试"
            }
        }
    ]
}

错误码

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

SDK示例

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