视频直播

产品文档

视频直播

帮助中心 > OpenAPI & SDK > 视频直播 > 查询水印模板列表

describeCustomLiveStreamWatermarkTemplates

描述

查询用户定义水印模板列表

请求方式

GET

请求地址

https://live.jdcloud-api.com/v1/watermarkCustoms

请求参数

名称 类型 是否必需 默认值 描述
pageNum Integer False 1 页码
- 取值范围 [1, 100000]
pageSize Integer False 10 分页大小
- 取值范围 [10, 100]
filters Filter[ ] False 水印模板列表查询过滤条件:
- name: template 录制模板自定义名称
- value: 如果参数为空,则查询全部

Filter

名称 类型 是否必需 默认值 描述
name String True 过滤条件的名称
operator String False 过滤条件的操作符,默认eq
values String[ ] True 过滤条件的值

返回参数

名称 类型 描述
result Result
requestId String requestId

Result

名称 类型 描述
pageNumber Integer 当前页码
pageSize Integer 每页数量
totalCount Integer 查询总数
watermarkTemplates WatermarkTemplate[ ] 水印模板

WatermarkTemplate

名称 类型 描述
offSetX Integer x轴偏移量
- 单位: 像素
offSetY Integer y轴偏移量
- 单位: 像素
width Integer 水印宽度
- 单位: 像素
height Integer 水印高度
- 单位: 像素
url String 水印地址
template String 水印模板自定义名称

返回码

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

请求示例

GET

https://live.jdcloud-api.com/v1/watermarkCustoms?filters.1.name=template&filters.1.values.1=yourwatermarktemplate

返回示例

{
    "requestId": "bgvmivir54gddpgi764se9f4kfr7ge41", 
    "result": {
        "pageNumber": 1, 
        "pageSize": 100, 
        "totalCount": 2, 
        "watermarkTemplates": [
            {
                "height": 200, 
                "offSetX": 10, 
                "offSetY": 50, 
                "template": "yourwatermarktemplate", 
                "url": "http://xxx.com/xxx.jpg", 
                "width": 155
            }
        ]
    }
}
更新时间:2019-07-16 16:48:47
文档反馈 docs feedback