服务端 API 文档

查询水印模板

最近更新时间:2019-07-11 17:24:24

接口名称

QueryWatermarkTemplate

功能说明

根据水印模板 ID,查询水印模板详细信息。

请求方式

请求域名

vod.api.qcloud.com

最高调用频率

100次/分钟

参数说明

参数名称 必填 类型 说明
definition Integer 水印模板 ID。
COMMON_PARAMS - 请参见 公共参数

请求示例

https://vod.api.qcloud.com/v2/index.php?Action=QueryWatermarkTemplate
&definition=403770
&COMMON_PARAMS

接口应答

参数说明

参数名称 类型 说明
code Integer 错误码,0:成功;其他值:失败。
message String 错误信息。
definition Integer 水印模板 ID。
name String 水印模板名。
type String 水印类型,固定为 image。
url String 水印的 URL 地址。
left String 水印图片左上角距离视频图像左上角的水平位置。
  • 带 % 结尾的字符串表示水印 left 为视频宽度百分比的大小,如10%表示 left 为视频宽度的10%。
  • 带 px 结尾的字符串表示 left 单位为像素,100px表示 left 为100像素。
  • 默认为0px。
    top String 水印图片左上角距离视频图像左上角的垂直位置。
  • 带 % 结尾的字符串表示水印 top 为视频高度百分比的大小,如10%表示 top 为视频宽度的10%。
  • 带 px 结尾的字符串表示 top 单位为像素,100px表示 top 为100像素。
  • 默认为0px。
    width String 水印图片的宽度。
  • 带 % 结尾的字符串表示 width 为视频宽度百分比的大小,如10%表示 width 为视频宽度的10%。
  • 带 px 结尾的字符串表示 width 单位为像素,100px表示 width 为100像素。
  • 默认为10%的视频宽度。
    height String 水印图片的高度。
  • 带 % 结尾的字符串表示水印 height 为视频高度百分比的大小,如10%表示 height 为视频高度的10%。
  • 带 px 结尾的字符串表示 height 单位为像素,100px表示 height 为100像素。
  • 默认为0px。
    comment String 对该模板的描述。
    status Integer 是否为默认模板,1:是;0:否。
    create_time Integer 模板创建时间(Unix 时间戳)。
    update_time Integer 模板更新时间(Unix 时间戳)。

    错误码说明

    错误码 含义说明
    4000 - 7000 请参见 公共错误码
    1000 无效参数。
    10702 内部处理错误。
    10704 水印模板不存在。

    应答示例

    {
        "code": 0,
        "message": "",
        "codeDesc": "Success",
        "name": "watermark_test",
        "definition": 403770,
        "create_time": 1510233336,
        "update_time": 1510233336,
        "comment": "",
        "type": "image",
        "url": "http://vodgzp1251132654-10022853.cosgzp.myqcloud.com/vodgzp1251132654/0/watermark/14508071098252378919.png",
        "left": "11%",
        "top": "10%",
        "width": "10%",
        "height": "10%",
        "status": 0,
        {...}
    }
    目录