文档首页/视频直播 Live/云直播API参考/直播水印管理/查询水印规则列表 - ListWatermarkRule
更新时间:2026-03-26 GMT+08:00

查询水印规则列表 - ListWatermarkRule

功能介绍

查询水印规则列表接口,通过指定条件,查询满足条件的水印规则列表。

调用方法

请参见如何调用API

授权信息

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

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

URI

GET /v1/{project_id}/watermark/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

template_id

String

参数解释

水印模板ID

约束限制

只包含数字、字母、中划线,创建模板时生成

取值范围

字符长度为[1-255]位

默认取值

不涉及

domain

String

参数解释

直播推流域名

约束限制

不涉及

取值范围

字符长度为[1-255]位

默认取值

不涉及

app

String

参数解释

应用名称

约束限制

不涉及

取值范围

字符长度为[1-128]位

默认取值

不涉及

channel_id

String

参数解释

OTT场景的频道ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

stream

String

参数解释

OTT场景填写转码模板ID,云直播场景填写流名

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

offset

Integer

参数解释

偏移量,表示从此偏移量开始查询

约束限制

不涉及

取值范围:

0~4096

默认取值:

0

limit

Integer

参数解释

每页记录数

约束限制

不涉及

取值范围:

1~100

默认取值:

10

请求参数

表3 请求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信息。

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

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

表5 响应Body参数

参数

参数类型

描述

total

Integer

参数解释

总条目数

取值范围

不涉及

rules_infos

Array of WatermarkRule objects

参数解释

水印规则列表

表6 WatermarkRule

参数

参数类型

描述

rule_name

String

参数解释

水印规则名称

约束限制

如果不填会使用默认名称。默认名称的构造规则为“域名:应用名:流名”,示例“example.com:live:stream”

取值范围

字符长度为[1,255]

默认取值

不涉及

template_id

String

参数解释

水印模板ID

约束限制

只包含数字、字母、中划线,创建模板时生成

取值范围

字符长度为[1-255]位

默认取值

不涉及

domain

String

参数解释

直播域名

约束限制

不涉及

取值范围

字符长度为[1-255]位

默认取值

不涉及

app

String

参数解释

应用名称

约束限制

云直播场景是可选配置,媒体直播场景为必选配置。

取值范围

字符长度为[1-128]位

默认取值

不涉及

stream

String

参数解释

流名称

约束限制

OTT场景可不填

取值范围

字符长度为[1-512]位

默认取值

不涉及

location

WatermarkLocation object

参数解释

水印位置

约束限制

不涉及

channel_id

String

参数解释

OTT场景使用,填写频道ID

约束限制

不涉及

取值范围

字符长度为[1,64]位

默认取值

不涉及

transcode_template_name

String

参数解释

OTT场景时,填写频道对应的转码模板名

约束限制

不涉及

取值范围

字符长度为[1,255]位

默认取值

不涉及

表7 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

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

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

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://live.hwcloud.com/v1/{project_id}/watermark/rules

响应示例

状态码:200

查询水印规则成功

{
  "total" : 1,
  "rules_infos" : [ {
    "template_id" : "70b76xxxxxx34253880af501cdxxxxxx",
    "domain" : "push.example.com",
    "app" : "live",
    "stream" : "watermarkStream",
    "location" : {
      "location" : "TOPLEFT",
      "x_offset" : 20,
      "y_offset" : 10
    }
  } ]
}

状态码: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
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 ListWatermarkRuleSolution {

    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();
        ListWatermarkRuleRequest request = new ListWatermarkRuleRequest();
        try {
            ListWatermarkRuleResponse response = client.listWatermarkRule(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
# 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 = ListWatermarkRuleRequest()
        response = client.list_watermark_rule(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
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.ListWatermarkRuleRequest{}
	response, err := client.ListWatermarkRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询水印规则成功

400

参数错误

错误码

请参见错误码