文档首页/视频直播 Live/云直播API参考/直播水印管理/创建水印模板 - CreateWatermarkTemplate
更新时间:2026-03-26 GMT+08:00
分享

创建水印模板 - CreateWatermarkTemplate

功能介绍

创建水印模板接口,需要绑定水印规则才生效

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/watermark/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必填,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必填,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必填,携带项目ID信息。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

水印模板名称

约束限制

不涉及

取值范围

字符长度为[1,255]

默认取值

不涉及

type

Integer

参数解释

水印类型

  • 0:图片

  • 1:文字

  • 2:图文共存

约束限制

不涉及

默认取值

不涉及

取值范围:

0~2

description

String

参数解释

模板注释

约束限制

不涉及

取值范围

字符长度为[0,512]

默认取值

不涉及

picture_url

String

参数解释

图片下载路径

约束限制

  • 校验规则:图片URL长度大于0,最大长度2048,能够正常按URL格式解析,必须是http或https协议。(OTT场景限制只支持https)

  • 图片格式:.png/.jpg/.PNG/.JPG结尾

取值范围

字符长度为[1,2048]

默认取值

不涉及

width

Number

参数解释

  • 整数型代表水印图片宽的像素值,范围0或[8,4096],单位px。

  • 小数型代表相对输出视频分辨率宽的比率,范围[0,1)。

约束限制

  • 建议宽高只设置一项,另外一项会自适应缩放,避免变形。宽高全部设置为0表示水印图片原始宽高。

  • 百分比限制最多保留小数点后4位,width和height 只支持同时为像素或是百分比,不支持一个像素,一个百分比。

默认取值

不涉及

取值范围:

0~4096

height

Number

参数解释

水印图片高,值有两种形式:

  • 整数型代表水印图片高的像素值,范围0或[8,4096],单位px。

  • 小数型代表相对输出视频分辨率高的比率,范围[0,1)。

约束限制

  • 建议宽高只设置一项,另外一项会自适应缩放,避免变形。宽高全部设置为0表示水印图片原始宽高。

  • 百分比限制最多保留小数点后4位,width和height 只支持同时为像素或是百分比,不支持一个像素,一个百分比。

默认取值

不涉及

取值范围:

0~4096

location

WatermarkLocation object

参数解释

水印位置

约束限制

不涉及

text

WordWaterMarkInfo object

参数解释

文字水印信息

约束限制

不涉及

scene

String

参数解释

业务属性

约束限制

不支持修改

取值范围

  • cloud_live 云直播

  • media_live 媒体直播

默认取值:

cloud_live

表4 WordWaterMarkInfo

参数

是否必选

参数类型

描述

format

String

参数解释

文字内容

约束限制

type取值为1或2时为必填项,type为0时为非必填项。

取值范围

字符串长度为1-64

默认取值

不涉及

font_color

String

参数解释

文字颜色

约束限制

不涉及

取值范围

参数校验:首位为#、除#外为6位或8位,每位字符由0-9、a~f、A~F组成【务必校验,错误时转码默认白色】。

默认取值:

#000000

font_size

Integer

参数解释

字体大小

约束限制

不涉及

取值范围:

4~72

默认取值:

14

font

String

参数解释

字体

约束限制

不涉及

取值范围

  • harmonyRegular:鸿蒙

  • douyu2.0:斗鱼追光体

字符串长度为1-20。

默认取值

缺省值为空

time_zone

String

参数解释

时区

约束限制

不涉及

取值范围

取值参考UTC-1200至UTC+1200,前三位UTC,第四位+或-,五六位表示小时,七八位固定00。

默认取值:

UTC+0800

shadow_color

String

参数解释

阴影颜色

约束限制

不涉及

取值范围

参数校验:首位为#、除#外为6位或8位,每位字符由0-9、a~f、A~F组成【务必校验,错误时转码默认黑色】。

默认取值

缺省值为none

location

WatermarkLocation object

参数解释

location位置

约束限制

必填

表5 WatermarkLocation

参数

是否必选

参数类型

描述

location

String

参数解释

水印位置

约束限制

不涉及

取值范围

  • TOPLEFT:左上

  • TOPRIGHT:右上

  • BOTTOMLEFT:左下

  • BOTTOMRIGHT:右下

  • RANDOM:随机模式,图片水印将随机在视频流的左上、右上、左下、右下四个位置展示。

默认取值

不涉及

x_offset

Number

参数解释

水印相对输出视频的水平偏移量。

取值有下述两种形式:

  • 整数型代表偏移像素,范围[1,4096],单位px。

  • 小数型代表水平偏移量与输出分辨率宽的比率,范围[0,1)。

约束限制

百分比限制最多保留小数点后4位。

默认取值

不涉及

取值范围:

0~4096

y_offset

Number

参数解释

水印相对输出视频的垂直偏移量。

取值有下述两种形式:

  • 整数型代表偏移像素,范围[1,4096],单位px。

  • 小数型代表垂直偏移量与输出分辨率高的比率,范围[0,1)。

约束限制

百分比限制最多保留小数点后4位。

默认取值

不涉及

取值范围:

0~4096

响应参数

状态码:201

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称)

表7 响应Body参数

参数

参数类型

描述

name

String

参数解释

水印模板名称

约束限制

不涉及

取值范围

字符长度为[1,255]

默认取值

不涉及

type

Integer

参数解释

水印类型

  • 0:图片

  • 1:文字

  • 2:图文共存

约束限制

不涉及

默认取值

不涉及

取值范围:

0~2

description

String

参数解释

模板注释

约束限制

不涉及

取值范围

字符长度为[0,512]

默认取值

不涉及

picture_url

String

参数解释

图片下载路径

约束限制

  • 校验规则:图片URL长度大于0,最大长度2048,能够正常按URL格式解析,必须是http或https协议。(OTT场景限制只支持https)

  • 图片格式:.png/.jpg/.PNG/.JPG结尾

取值范围

字符长度为[1,2048]

默认取值

不涉及

width

Number

参数解释

  • 整数型代表水印图片宽的像素值,范围0或[8,4096],单位px。

  • 小数型代表相对输出视频分辨率宽的比率,范围[0,1)。

约束限制

  • 建议宽高只设置一项,另外一项会自适应缩放,避免变形。宽高全部设置为0表示水印图片原始宽高。

  • 百分比限制最多保留小数点后4位,width和height 只支持同时为像素或是百分比,不支持一个像素,一个百分比。

默认取值

不涉及

取值范围:

0~4096

height

Number

参数解释

水印图片高,值有两种形式:

  • 整数型代表水印图片高的像素值,范围0或[8,4096],单位px。

  • 小数型代表相对输出视频分辨率高的比率,范围[0,1)。

约束限制

  • 建议宽高只设置一项,另外一项会自适应缩放,避免变形。宽高全部设置为0表示水印图片原始宽高。

  • 百分比限制最多保留小数点后4位,width和height 只支持同时为像素或是百分比,不支持一个像素,一个百分比。

默认取值

不涉及

取值范围:

0~4096

location

WatermarkLocation object

参数解释

水印位置

约束限制

不涉及

text

WordWaterMarkInfo object

参数解释

文字水印信息

约束限制

不涉及

scene

String

参数解释

业务属性

约束限制

不支持修改

取值范围

  • cloud_live 云直播

  • media_live 媒体直播

默认取值:

cloud_live

表8 WordWaterMarkInfo

参数

参数类型

描述

format

String

参数解释

文字内容

约束限制

type取值为1或2时为必填项,type为0时为非必填项。

取值范围

字符串长度为1-64

默认取值

不涉及

font_color

String

参数解释

文字颜色

约束限制

不涉及

取值范围

参数校验:首位为#、除#外为6位或8位,每位字符由0-9、a~f、A~F组成【务必校验,错误时转码默认白色】。

默认取值:

#000000

font_size

Integer

参数解释

字体大小

约束限制

不涉及

取值范围:

4~72

默认取值:

14

font

String

参数解释

字体

约束限制

不涉及

取值范围

  • harmonyRegular:鸿蒙

  • douyu2.0:斗鱼追光体

字符串长度为1-20。

默认取值

缺省值为空

time_zone

String

参数解释

时区

约束限制

不涉及

取值范围

取值参考UTC-1200至UTC+1200,前三位UTC,第四位+或-,五六位表示小时,七八位固定00。

默认取值:

UTC+0800

shadow_color

String

参数解释

阴影颜色

约束限制

不涉及

取值范围

参数校验:首位为#、除#外为6位或8位,每位字符由0-9、a~f、A~F组成【务必校验,错误时转码默认黑色】。

默认取值

缺省值为none

location

WatermarkLocation object

参数解释

location位置

约束限制

必填

表9 WatermarkLocation

参数

参数类型

描述

location

String

参数解释

水印位置

约束限制

不涉及

取值范围

  • TOPLEFT:左上

  • TOPRIGHT:右上

  • BOTTOMLEFT:左下

  • BOTTOMRIGHT:右下

  • RANDOM:随机模式,图片水印将随机在视频流的左上、右上、左下、右下四个位置展示。

默认取值

不涉及

x_offset

Number

参数解释

水印相对输出视频的水平偏移量。

取值有下述两种形式:

  • 整数型代表偏移像素,范围[1,4096],单位px。

  • 小数型代表水平偏移量与输出分辨率宽的比率,范围[0,1)。

约束限制

百分比限制最多保留小数点后4位。

默认取值

不涉及

取值范围:

0~4096

y_offset

Number

参数解释

水印相对输出视频的垂直偏移量。

取值有下述两种形式:

  • 整数型代表偏移像素,范围[1,4096],单位px。

  • 小数型代表垂直偏移量与输出分辨率高的比率,范围[0,1)。

约束限制

百分比限制最多保留小数点后4位。

默认取值

不涉及

取值范围:

0~4096

状态码:400

表10 响应Header参数

参数

参数类型

描述

X-request-id

String

此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称)

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v1/{project_id}/watermark/templates

{
  "name" : "MyWatermarkTemplate",
  "type" : 0,
  "description" : "my demo template",
  "picture_url" : "http://example.com/picture",
  "width" : 0.1,
  "height" : 0.1,
  "location" : {
    "location" : "TOPLEFT",
    "x_offset" : 20,
    "y_offset" : 10
  }
}

响应示例

状态码:201

创建水印模板操作成功

{
  "name" : "string",
  "type" : 1,
  "description" : "string",
  "picture_url" : "string",
  "width" : 4096,
  "height" : 4096,
  "location" : {
    "location" : "string",
    "x_offset" : 4096,
    "y_offset" : 4096
  }
}

状态码:400

创建水印模板操作失败

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;


public class CreateWatermarkTemplateSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateWatermarkTemplateRequest request = new CreateWatermarkTemplateRequest();
        WatermarkTemplate body = new WatermarkTemplate();
        WatermarkLocation locationbody = new WatermarkLocation();
        locationbody.withLocation(WatermarkLocation.LocationEnum.fromValue("TOPLEFT"))
            .withXOffset(java.math.BigDecimal.valueOf(20))
            .withYOffset(java.math.BigDecimal.valueOf(10));
        body.withLocation(locationbody);
        body.withHeight(java.math.BigDecimal.valueOf(0.1));
        body.withWidth(java.math.BigDecimal.valueOf(0.1));
        body.withPictureUrl("http://example.com/picture");
        body.withDescription("my demo template");
        body.withType(0);
        body.withName("MyWatermarkTemplate");
        request.withBody(body);
        try {
            CreateWatermarkTemplateResponse response = client.createWatermarkTemplate(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateWatermarkTemplateRequest()
        locationbody = WatermarkLocation(
            location="TOPLEFT",
            x_offset=20,
            y_offset=10
        )
        request.body = WatermarkTemplate(
            location=locationbody,
            height=0.1,
            width=0.1,
            picture_url="http://example.com/picture",
            description="my demo template",
            type=0,
            name="MyWatermarkTemplate"
        )
        response = client.create_watermark_template(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateWatermarkTemplateRequest{}
	locationLocation:= model.GetWatermarkLocationLocationEnum().TOPLEFT
	xOffsetLocation:= float32(20)
	yOffsetLocation:= float32(10)
	locationbody := &model.WatermarkLocation{
		Location: &locationLocation,
		XOffset: &xOffsetLocation,
		YOffset: &yOffsetLocation,
	}
	heightWatermarkTemplate:= float32(0.1)
	widthWatermarkTemplate:= float32(0.1)
	pictureUrlWatermarkTemplate:= "http://example.com/picture"
	descriptionWatermarkTemplate:= "my demo template"
	typeWatermarkTemplate:= int32(0)
	request.Body = &model.WatermarkTemplate{
		Location: locationbody,
		Height: &heightWatermarkTemplate,
		Width: &widthWatermarkTemplate,
		PictureUrl: &pictureUrlWatermarkTemplate,
		Description: &descriptionWatermarkTemplate,
		Type: &typeWatermarkTemplate,
		Name: "MyWatermarkTemplate",
	}
	response, err := client.CreateWatermarkTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

创建水印模板操作成功

400

创建水印模板操作失败

错误码

请参见错误码

相关文档