明水印接口

更新时间：2025-08-21

创建水印

请求（Request）

请求语法：

Http

1POST /v{version}/watermark HTTP/1.1
2accept-encoding: gzip, deflate
3x-bce-date: {utc-date-string}
4host: media.bj.baidubce.com
5accept: */*
6connection: keep-alive
7x-bce-request-id: {bce-request-id}
8content-type: application/json
9authorization: {bce-authorization-string}

请求头域：无特殊Header参数
请求参数（以下均为Requestbody参数）：

字段名称	字段类型	必要性	字段描述	可选值	默认值
bucket	String	必选	BOS存储上水印文件Bucket	-	-
key	String	必选	BOS存储上水印文件Key，支持JPG、PNG、APNG、BMP、PBM、TIF、GIF 、MOV等格式，其中MOV、GIF、APNG为动态水印	-	-
verticalAlignment	String	可选	垂直对齐方式	top, center, bottom	top
horizontalAlignment	String	可选	水平对齐方式	left, center, right	left
verticalOffsetInPixel	Number	可选	垂直偏移，该参数仅在verticalAlignment设置为top或bottom时有效，单位：像素	0 ~ 3072	0
horizontalOffsetInPixel	Number	可选	水平偏移，该参数仅在horizontalAlignment设置为left或right时有效，单位：像素	0 ~ 4096	0
timeline	Object	可选	水印有效显示起止时间（仅当watermarkId被设置到Preset.watermarks.image多水印参数中时该字段可生效）	-	-
+ startTimeInMillisecond	Number	可选	水印显示起始时间，单位：毫秒	大于等于0	-（为空表示从第0s开始）
+ durationInMillisecond	Number	可选	水印显示持续时间，单位：毫秒	大于等于0	-（为空表示持续视频时长）
repeated	Number	可选	（动态）水印重复显示次数，为0表示无限循环（仅当watermarkId被设置到Preset.watermarks.image多水印参数中时该字段可生效）	大于等于0	1
allowScaling	Bool	可选	是否允许自动进行缩放（仅当watermarkId被设置到Preset.watermarks.image多水印参数中时该字段可生效）	true、false	true

请求示例：

Http

1POST /v3/watermark HTTP/1.1
2accept-encoding: gzip, deflate
3x-bce-date: 2015-03-24T13:08:44Z
4host: media.bj.baidubce.com
5accept: */*
6connection: keep-alive
7x-bce-request-id: d97c57d0-ca44-4d1c-bfeb-941a92440968
8content-type: application/json
9authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:08:44Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
10
11{
12    "bucket" : "samplebucket",
13    "key" : "samplefolderpath/samplewatermark.png",
14    "verticalOffsetInPixel" : 0,
15    "horizontalOffsetInPixel" : 0
16}

响应（Reponse）

响应头域：无特殊Header参数
响应参数：

字段名称	字段类型	字段描述
watermarkId	String	水印的唯一标识

响应示例：

Http

1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: d97c57d0-ca44-4d1c-bfeb-941a92440968
4Cache-Control: no-cache
5Server: BWS
6Date: Tue, 24 Mar 2015 13:34:07 GMT
7Content-Type: application/json;charset=UTF-8
8
9{
10    "watermarkId" : "wmk-lsdspxdastmnbama"
11}

查询指定水印

请求（Request）

请求语法：

Http

1GET /v{version}/watermark/{watermarkId} HTTP/1.1
2accept-encoding: gzip, deflate
3x-bce-date: {utc-date-string}
4host: media.bj.baidubce.com
5accept: */*
6connection: keep-alive
7x-bce-request-id: {bce-request-id}
8content-type: application/json
9authorization: {bce-authorization-string}

请求头域：无特殊Header参数
请求参数：无

请求示例：

Http

1POST /v3/watermark/wmk-lsdspxdastmnbama HTTP/1.1
2accept-encoding: gzip, deflate
3x-bce-date: 2015-03-24T13:08:44Z
4host: media.bj.baidubce.com
5accept: */*
6connection: keep-alive
7x-bce-request-id: 9c1f8229-a8d4-46e1-b8e2-25412e0eee63
8content-type: application/json
9authorization: bce-auth-v1/535f3834e538448aa88f3c589bab2ea3/2015-03-24T13:08:44Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应（Reponse）

响应头域：无特殊Header参数
响应参数：与[创建水印/请求/请求参数]保持一致，增加以下字段

字段名称	字段类型	字段描述
watermarkId	String	水印的唯一标识
createTime	Date	水印创建时间

响应示例：

Http

1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: 9c1f8229-a8d4-46e1-b8e2-25412e0eee63
4Cache-Control: no-cache
5Server: BWS
6Date: Tue, 24 Mar 2015 13:34:07 GMT
7Content-Type: application/json;charset=UTF-8
8
9{
10    "watermarkId" : "wmk-lsdspxdastmnbama",
11    "createTime": "2015-05-11T12:42:21Z",
12    "bucket" : "samplebucket",
13    "key" : "samplefolderpath/samplewatermark.png",
14    "verticalOffsetInPixel" : 0,
15    "horizontalOffsetInPixel" : 0
16}

查询当前用户水印

请求（Request）

请求语法：

Http

1GET /v{version}/watermark HTTP/1.1
2accept-encoding: gzip, deflate
3x-bce-date: {utc-date-string}
4host: media.bj.baidubce.com
5accept: */*
6connection: keep-alive
7x-bce-request-id: {bce-request-id}
8content-type: application/json
9authorization: {bce-authorization-string}

请求头域：无特殊Header参数
请求参数：无

请求示例：

Http

1GET /v3/watermark HTTP/1.1
2accept-encoding: gzip, deflate
3x-bce-date: 2015-03-24T13:08:44Z
4host: media.bj.baidubce.com
5accept: */*
6connection: keep-alive
7x-bce-request-id: 249ac308-4554-4825-ab0f-867dd92024d8
8content-type: application/json
9authorization: bce-auth-v1/02296dd93f1940a39913d9a406332486/2015-03-24T13:08:44Z/1800/host;x-bce-date/cef8a3207e29c4663292c42665de1154e760c734f82248b36a71be2bb3281b1d

响应（Reponse）

响应头域：无特殊Header参数
响应参数：与[创建水印/请求/请求参数]保持一致，增加以下字段

字段名称	字段类型	字段描述
watermarkId	String	水印的唯一标识
createTime	Date	水印创建时间

响应示例：

Http

1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: 249ac308-4554-4825-ab0f-867dd92024d8
4Cache-Control: no-cache
5Server: BWS
6Date: Tue, 24 Mar 2015 13:34:07 GMT
7Content-Type: application/json;charset=UTF-8
8
9{
10    "watermarks": [
11        {
12            "watermarkId" : "wmk-lsdspxdastmnbama",
13            "createTime": "2015-05-11T12:42:21Z",
14            "bucket" : "samplebucket",
15            "key" : "samplefolderpath/samplewatermark.png",
16            "verticalOffsetInPixel" : 0,
17            "horizontalOffsetInPixel" : 0
18        },
19        {
20            "watermarkId" : "wmk-feji7exr57r3824x",
21            "createTime": "2015-05-07T12:34:20Z",
22            "bucket" : "samplebucket",
23            "key" : "samplefolderpath/samplewatermark1.png",
24            "verticalOffsetInPixel" : 150,
25            "horizontalOffsetInPixel" : 40
26        },
27        {
28            "watermarkId" : "wmk-lsdspxdastmnbama",
29            "createTime": "2015-05-08T12:22:15Z",
30            "bucket" : "samplebucket2",
31            "key" : "samplefolderpath/samplewatermark.png",
32            "verticalOffsetInPixel" : 0,
33            "horizontalOffsetInPixel" : 200
34        }
35    ]
36}

删除水印

请求（Request）

请求语法：

Http

1DELETE /v{version}/watermark/{watermarkId} HTTP/1.1
2accept-encoding: gzip, deflate
3x-bce-date: {utc-date-string}
4host: media.bj.baidubce.com
5accept: */*
6connection: keep-alive
7x-bce-request-id: {bce-request-id}
8content-type: application/json
9authorization: {bce-authorization-string}

请求头域：无特殊Header参数
请求参数：无

请求示例：

Http

1DELETE /v3/watermark/wmk-lsdspxdastmnbama HTTP/1.1
2accept-encoding: gzip, deflate
3x-bce-date: 2015-03-24T13:08:44Z
4host: media.bj.baidubce.com
5accept: */*
6connection: keep-alive
7x-bce-request-id: f922935d-cf8a-4078-a43a-dc3475ab3a70
8content-type: application/json
9authorization: bce-auth-v1/535f3834e538448aa88f3c589bab2ea3/2015-03-24T13:08:44Z/1800/host;x-bce-date/19468bb170d1073c5cdd292f4424d80d259d0a17528648426f305d39a2d6c452

响应（Response）

响应头域：无特殊Header参数
响应参数：无

响应示例：

Http

1HTTP/1.1 200 OK
2x-bce-request-id: f922935d-cf8a-4078-a43a-dc3475ab3a70
3Cache-Control: no-cache

常见异常

水印不存在

异常代码：404
异常字段：watermark: XXXX does not exist
产生原因： 1.试图查询/删除不存在（未创建/已删除）的水印 2.创建转码模板使用了不存在的水印

水印图片不存在

异常代码：404
异常字段：bos object: XXXX does not exist
产生原因： 1.创建水印时使用了不存在的bos object 2.创建job时引用了不存在的bos object（转码源视频或水印图片）

水印无法删除

异常代码：400
异常字段：watermark is in use, please delete the relative presets first
产生原因： 1.试图删除的水印正在被当前活跃的preset使用，建议用户先删除对应的preset

Transmux模式下增加水印

异常代码：400
watermark is not supported in Transmux mode
产生原因： 1.试图在Transmux模式下添加水印，改模式不进行重新编码所以无法添加水印

接口规范

视频转码任务接口

音视频处理 MCT

音视频处理 MCT

明水印接口

创建水印

查询指定水印

查询当前用户水印

删除水印

常见异常