# 查询水印模板配置 - ShowWatermarkTemplate #### 功能介绍 查询水印模板详情接口 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-live/live_03_0001.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-live/live_03_0013.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/watermark/templates/{id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-live/live_03_0023.html)。 | | id | 是 | String | **参数解释**： 模板ID **约束限制**： 在创建成功后返回 **取值范围**： 字符长度为\[1,128\]位 **默认取值**： 不涉及 | #### 请求参数 表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信息。 | #### 响应参数 **状态码：200** 表3响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） | 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 水印模板名称 **取值范围**： 字符长度为\[1,255\] | | type | Integer | **参数解释**： 水印类型 - 0：图片 - 1：文字 - 2：图文共存 **取值范围：** 0\~2 | | description | String | **参数解释**： 模板注释 **取值范围**： 字符长度为\[0,512\] | | picture_url | String | **参数解释**： 图片下载路径 **取值范围**： 字符长度为\[1,2048\] | | width | Number | **参数解释**： - 整数型代表水印图片宽的像素值，范围0或\[8，4096\]，单位px。 - 小数型代表相对输出视频分辨率宽的比率，范围\[0,1)。 **取值范围：** 0\~4096 | | height | Number | **参数解释**： 水印图片高，值有两种形式： - 整数型代表水印图片高的像素值，范围0或\[8，4096\]，单位px。 - 小数型代表相对输出视频分辨率高的比率，范围\[0，1)。 **取值范围：** 0\~4096 | | location | [WatermarkLocation] object | **参数解释**： 水印位置 | | text | [WordWaterMarkInfo] object | **参数解释**： 文字水印信息 | | scene | String | **参数解释**： 业务属性 **取值范围**： - cloud_live 云直播 - media_live 媒体直播，媒体直播仅支持在国际站使用。 | 表5WordWaterMarkInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | format | String | **参数解释**： 文字内容 **取值范围**： 字符串长度为1-64 | | font_color | String | **参数解释**： 文字颜色 **取值范围**： 参数校验：首位为#、除#外为6位或8位，每位字符由0-9、a\~f、A\~F组成【务必校验，错误时转码默认白色】。 | | font_size | Integer | **参数解释**： 字体大小 **取值范围：** 4\~72 | | font | String | **参数解释**： 字体 **取值范围**： - harmonyRegular：鸿蒙 - douyu2.0：斗鱼追光体 字符串长度为1-20。 | | time_zone | String | **参数解释**： 时区 **取值范围**： 取值参考UTC-1200至UTC+1200，前三位UTC，第四位+或-，五六位表示小时，七八位固定00。 | | shadow_color | String | **参数解释**： 阴影颜色 **取值范围**： 参数校验：首位为#、除#外为6位或8位，每位字符由0-9、a\~f、A\~F组成【务必校验，错误时转码默认黑色】。 | | location | [WatermarkLocation] object | **参数解释**： location位置 | 表6WatermarkLocation | 参数 | 参数类型 | 描述 | |:---|:---|:---| | location | String | **参数解释**： 水印位置 **取值范围**： - TOPLEFT：左上 - TOPRIGHT：右上 - BOTTOMLEFT：左下 - BOTTOMRIGHT：右下 - RANDOM：随机模式。选择随机模式后，图片水印将随机在视频流的左上、右上、左下、右下四个位置展示，具体展示的位置点还与参数x_offset和y_offset的设置值有关，且每5\~30分钟更换一次水印展示位置。 | | x_offset | Number | **参数解释**： 水印相对输出视频的水平偏移量。 取值有下述两种形式： - 整数型代表偏移像素，范围\[1，4096\]，单位px。 - 小数型代表水平偏移量与输出分辨率宽的比率，范围\[0，1)。 **取值范围：** 0\~4096 | | y_offset | Number | **参数解释**： 水印相对输出视频的垂直偏移量。 取值有下述两种形式： - 整数型代表偏移像素，范围\[1，4096\]，单位px。 - 小数型代表垂直偏移量与输出分辨率高的比率，范围\[0，1)。 **取值范围：** 0\~4096 | **状态码：400** 表7响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） | 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 ``` GET https://{endpoint}/v1/{project_id}/watermark/templates/e89b76xxxxxx3425ui80af501cdxxxxxx ``` #### 响应示例 **状态码：200** 查询水印模板成功 ``` { "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 } } ``` **状态码：400** 查询水印模板失败 ``` { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowWatermarkTemplateSolution { 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("")) .build(); ShowWatermarkTemplateRequest request = new ShowWatermarkTemplateRequest(); request.withId("{id}"); try { ShowWatermarkTemplateResponse response = client.showWatermarkTemplate(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ShowWatermarkTemplateRequest() request.id = "{id}" response = client.show_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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := live.LiveClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := live.NewLiveClient(hcClient) request := &model.ShowWatermarkTemplateRequest{} request.Id = "{id}" response, err := client.ShowWatermarkTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Live/sdk?api=ShowWatermarkTemplate)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询水印模板成功 | | 400 | 查询水印模板失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。