视频数字水印模板接口
更新时间：2024-11-07
创建数字水印模板
接口描述
用户通过该接口创建数字水印模板，可用于大批量嵌入固定的数字水印内容，每个数字水印模板拥有唯一ID标识。 成功创建数字水印模板后，可在转码模板内配置数字水印模板ID，然后使用含数字水印模板的转码模板发起转码任务以嵌入数字水印。详情参考在转码模板中配置数字水印。
若业务场景下需嵌入的水印内容频繁变化(例如需要为每个视频嵌入不同的信息)，推荐直接在转码任务中配置数字水印，无需创建数字水印模板。详情参考在转码任务中配置数字水印。
请求结构
POST /v{version}/digitalwatermark HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: {utc-date-string}
connection: keep-alive
accept: */*
host: media.bj.baidubce.com
x-bce-request-id: {bce-request-id}
content-type: application/json
authorization: {bce-authorization-string}请求头域
除公共头域外，无其它特殊头域。
请求参数
无
请求体
| 字段名称 | 字段类型 | 必要性 | 字段描述 | 可选值 | 默认值 |
|---|---|---|---|---|---|
| digitalWmId | String | 可选 | 数字水印模板的唯一标识 | 字符串长度<20 | 如果不设置, 会自动生成一个数字水印ID, 格式为: dwm-16位随机id |
| description | String | 可选 | 自定义描述信息 | 字符串长度<128 | 空字符串 |
| digitalWmType | String | 必选 | 水印类型，可选"image"(图片)或"text"(文字) | "image", "text" | - |
| bucket | String | 水印类型为"image"时必选 | 图片水印的BOS Bucket | - | - |
| key | String | 水印类型为"image"时必选 | 图片水印的BOS Key | - | - |
| textContent | String | 水印类型为"text"时必选 | 文字水印的内容 | - | - |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| digitalWmId | String | 数字水印模板的唯一标识 |
请求示例
POST /v3/digitalwatermark HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2023-11-08T21:21:21Z
host: media.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2023-11-08T21:21:21Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9
{
"description": "image digital watermark",
"digitalWmType": "image",
"bucket": "test",
"key": "wm.png"
}响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: d97c57d0-ca44-4d1c-bfeb-941a92440968
Cache-Control: no-cache
Server: BWS
Date: Wed, 08 Nov 2023 07:36:48 GMT
Content-Type: application/json;charset=UTF-8
{
"digitalWmId": "dwm-pa4mz6n8i7sefz0p"
}查询指定数字水印模板
接口描述
用户通过该接口查询已创建的数字水印模板。
请求结构
GET /v{version}/digitalwatermark/{digitalWmId} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: {utc-date-string}
connection: keep-alive
accept: */*
host: media.bj.baidubce.com
x-bce-request-id: {bce-request-id}
content-type: application/json
authorization: {bce-authorization-string}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 字段名称 | 字段类型 | 必要性 | 字段描述 | 可选值 | 默认值 |
|---|---|---|---|---|---|
| digitalWmId | String | 必选 | 数字水印模板的唯一标识 | - | - |
请求体
无
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| digitalWmId | String | 数字水印模板的唯一标识 |
| description | String | 自定义描述信息 |
| createTime | String | 创建时间 |
| state | String | 模板状态，ACTIVE/INACTIVE |
| digitalWmType | String | 水印类型，可能为"image"(图片)或"text"(文字) |
| bucket | String | 水印图片的BOS Bucket |
| key | String | 水印图片的BOS Key |
| textContent | String | 水印文字的内容 |
请求示例
GET /v3/digitalwatermark/dwm-pa4mz6n8i7sefz0p HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2023-11-08T21:21:21Z
host: media.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2023-11-08T21:21:21Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: d97c57d0-ca44-4d1c-bfeb-941a92440968
Cache-Control: no-cache
Server: BWS
Date: Wed, 08 Nov 2023 07:36:48 GMT
Content-Type: application/json;charset=UTF-8
{
"digitalWmId": "dwm-pa4mz6n8i7sefz0p",
"description": "image digital watermark",
"createTime": "2023-01-05T07:30:46Z",
"state": "ACTIVE",
"digitalWmType": "image",
"bucket": "test",
"key": "wm.png"
}查询所有数字水印模板
接口描述
用户通过该接口查询所有已创建数字水印模板构成的列表。
请求结构
GET /v{version}/digitalwatermark/ HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: {utc-date-string}
connection: keep-alive
accept: */*
host: media.bj.baidubce.com
x-bce-request-id: {bce-request-id}
content-type: application/json
authorization: {bce-authorization-string}请求头域
除公共头域外，无其它特殊头域。
请求参数
无
请求体
无
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| digitalWatermarks | Array |
数字水印模板列表 |
DigitalWatermark内部字段定义见查询指定数字水印模板的响应参数。
请求示例
GET /v3/digitalwatermark/ HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2023-11-08T21:21:21Z
host: media.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2023-11-08T21:21:21Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9响应示例
HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: d97c57d0-ca44-4d1c-bfeb-941a92440968
Cache-Control: no-cache
Server: BWS
Date: Wed, 08 Nov 2023 07:36:48 GMT
Content-Type: application/json;charset=UTF-8
{
"digitalWatermarks": [
{
"digitalWmId": "dwm-pa4mz6n8i7sefz0p",
"description": "image digital watermark",
"createTime": "2023-01-05T07:30:46Z",
"state": "ACTIVE",
"digitalWmType": "image",
"bucket": "test",
"key": "wm.png"
},
{
"digitalWmId": "dwm-pfvp7sdq2mrrg422",
"description": "text digital watermark",
"createTime": "2023-01-05T07:30:46Z",
"state": "ACTIVE",
"digitalWmType": "text",
"textContent": "baidu"
}
]
}删除指定数字水印模板
接口描述
用户通过该接口删除已创建的数字水印模板。
请求结构
DELETE /v{version}/digitalwatermark/{digitalWmId} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: {utc-date-string}
connection: keep-alive
accept: */*
host: media.bj.baidubce.com
x-bce-request-id: {bce-request-id}
content-type: application/json
authorization: {bce-authorization-string}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 字段名称 | 字段类型 | 必要性 | 字段描述 | 可选值 | 默认值 |
|---|---|---|---|---|---|
| digitalWmId | String | 必选 | 数字水印模板的唯一标识 | - | - |
请求体
无
响应头域
除公共头域外，无其它特殊头域。
响应参数
无
请求示例
DELETE /v3/digitalwatermark/dwm-pa4mz6n8i7sefz0p HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2023-11-08T21:21:21Z
host: media.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2023-11-08T21:21:21Z/1800/host;x-bce-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9响应示例
HTTP/1.1 200 OK
x-bce-request-id: 6d0b0a36-2ffe-49d4-9d81-333a9ab9417e
Cache-Control: no-cache其他说明
暂不支持修改已有模板内容或删除后重新创建同ID模板。