视频点播

产品文档

视频点播

listWatermarks

描述

查询水印列表

请求方式

GET

请求地址

https://vod.jdcloud-api.com/v1/watermarks

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 1 页码;默认值为 1
pageSize Integer False 10 分页大小;默认值为 10;取值范围 [10, 100]

返回参数

名称 类型 描述
result Result 查询水印列表结果
requestId String 请求ID

Result

名称 类型 描述
pageNumber Integer 当前页码
pageSize Integer 每页数量
totalElements Integer 查询总数
totalPages Integer 总页数
content WatermarkObject[ ] 分页内容

WatermarkObject

名称 类型 描述
id Long 水印ID
name String 水印名称。只支持中英文、数字。长度不超过128个字符。UTF-8编码。
imgUrl String 图片地址
width String 水印宽度。
当 sizeUnit = pixel 时,取值范围为 [8, 4096] 整数
当 sizeUnit = percent 时,取值范围为 [0, 100] 小数
height String 水印高度。
当 sizeUnit = pixel 时,取值范围为 [8, 4096] 整数
当 sizeUnit = percent 时,取值范围为 [0, 100] 小数
sizeUnit String 尺寸单位。取值范围:
pixel - 像素
percent - 百分比
默认值为 pixel
widthRef String
heightRef String 高度参考,仅当 siteUnit = percent 时生效。
取值说明:
w: 输出水印高度 = height * 水印原图高度
v: 等同于 vh
vw: 输出水印高度 = height * 输出视频宽度
vh: 输出水印高度 = height * 输出视频高度
vls: 输出水印高度 = height * 输出视频长边
vss: 输出水印高度 = height * 输出视频短边
position String 水印位置。取值范围:
LT - 左上
RT - 右上
LB - 左下
RB - 右下
offsetX String 水平偏移。
当 offsetUnit = pixel 时,取值范围为 [8, 4088] 整数
当 offsetUnit = percent 时,取值范围为 [0, 100] 小数
offsetY String 竖直偏移。
当 offsetUnit = pixel 时,取值范围为 [8, 4088] 整数
当 offsetUnit = percent 时,取值范围为 [0, 100] 小数
offsetUnit String 偏移单位。取值范围:
pixel - 像素
percent - 百分比
默认值为 pixel
createTime String 创建时间
updateTime String 修改时间

返回码

返回码 描述
200 OK
400 Invalid parameter
401 Authentication failed
404 Not found
500 Internal server error
503 Service unavailable

请求示例

GET

https://vod.jdcloud-api.com/v1/watermarks

返回示例

{
    "requestId": "edfc74ea-be4c-418b-b841-31ddd2b33203", 
    "result": {
        "content": [
            {
                "createTime": "2019-04-16T15:51:32Z", 
                "height": 50, 
                "id": 10001, 
                "imgUrl": "http://s3.cn-north-1-stag.jcloudcs.com/vod-storage-72757/image/ecd9066c0f2c8e4bbd8a9fd7ae37965f.PNG", 
                "name": "Mango", 
                "offsetUnit": "pixel", 
                "offsetX": 32, 
                "offsetY": 16, 
                "position": "LT", 
                "sizeUnit": "pixel", 
                "updateTime": "2019-04-16T15:51:32Z", 
                "width": 100
            }
        ], 
        "pageNumber": 1, 
        "pageSize": 10, 
        "totalElements": 1, 
        "totalPages": 1
    }
}
更新时间:2020-11-23 17:16:00
文档反馈 docs feedback