文档首页/ 视频点播 VOD/ API参考/ 水印模板管理/ 查询水印列表
更新时间：2024-12-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询水印列表

功能介绍

查询水印模板

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1.0/{project_id}/template/watermark

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID
表2 Query参数

参数

是否必选

参数类型

描述

id

否

Array of strings

水印模板配置id，一次最多10个。

page

否

Integer

分页编号。

默认为0。指定id时该参数无效。

size

否

Integer

每页记录数。

默认为10，范围[1,100]。指定id时该参数无效。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token，使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

templates

Array of WatermarkTemplate objects

水印模板信息。

total

Integer

总数。
表5 WatermarkTemplate

参数

参数类型

描述

name

String

水印模板名称。

id

String

水印模板配置id。

status

Long

启用状态。

取值为：

  • 0：停用

  • 1：启用

dx

String

水印图片相对输出视频的水平偏移量。

默认值是0。

dy

String

水印图片相对输出视频的垂直偏移量。

默认值是0。

position

String

水印的位置。

width

String

水印图片宽。

height

String

水印图片高。

create_time

String

创建时间。

image_url

String

水印图片下载url。

type

String

水印图片格式类型。

watermark_type

String

水印类型，当前只支持IMAGE（图片水印）。

image_process

String

watermark_type设置为IMAGE时有效。

目前包括：

  • ORIGINAL：只做简单缩放，不做其他处理

  • TRANSPARENT：图片底色透明

  • GRAYED：彩色图片变灰

timeline_start

String

水印开始时间，与"timeline_duration"配合使用。

取值范围:[0, END)。"END"表示视频结束时间。

单位:秒。

timeline_duration

String

水印持续时间，与"timeline_start"配合使用。

取值范围:(0,END-开始时间]。"END"表示视频结束时间。

单位:秒。

默认:END。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v1.0/{project_id}/template/watermark?id={id}

响应示例

状态码： 200

处理成功返回。

{
  "templates" : [ {
    "name" : "test",
    "id" : "2305739f855413a84af9e6ad6ebb21be",
    "status" : 0,
    "dx" : "0.05",
    "dy" : "0.05",
    "position" : "TOPRIGHT",
    "width" : "0.12",
    "height" : null,
    "create_time" : "20210204092325",
    "image_url" : "https://103-cn-north-4.cdn-vod.huaweicloud.com/05ab5cef408026f22f62c018de60cf2e/watermark/2305739f855413a84af9e6ad6ebb21be.png",
    "type" : "PNG",
    "watermark_type" : "IMAGE",
    "image_process" : "TRANSPARENT",
    "timeline_start" : null,
    "timeline_duration" : null
  } ],
  "total" : 1
}

状态码： 400

处理失败返回。

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

状态码

状态码

描述

200

处理成功返回。

400

处理失败返回。

错误码

请参见错误码。

父主题： 水印模板管理

相关文档