文档中心

查询水印列表

最近更新时间：2023.10.12 17:39:58

首次发布时间：2022.06.09 10:51:22

查询视频直播配置空间 Vhost 下的水印列表。

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询水印列表接口。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=ListVhostWatermarkPreset&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListVhostWatermarkPreset`	接口名称。当前 API 的名称为 `ListVhostWatermarkPreset`。
Version	String	是	`2020-08-01`	接口版本。当前 API 的版本为 `2020-08-01`。

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`push.example.com`	域名空间名称。由 1 到 60 位数字、字母、下划线及"-"和"."组成

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
WatermarkPresetList	Array of WatermarkPresetList	`-`	水印模版列表
WatermarkErrMsgList	Array of WatermarkErrMsgList	`-`	获取模板失败的列表，返回获取失败的模版及获取失败的原因
StaticsMsg	String	`successfully get all 1 watermark presets of current vhost`	统计消息，提供查询成功和失败的数量

WatermarkPresetList

参数	类型	示例值	描述
ID	Integer	`****1`	水印模版 ID
AccountID	String	`****1`	火山引擎账号 ID
Vhost	String	`push.example.com`	域名空间名称
App	String	`example_app`	应用名称
Picture	String	`data:image/png;base64,iVBORw0KGg****mCC`	水印图片链接
PictureKey	String	`testtesttest.png`	水印图片文件名
Orientation	String	`vertical`	直播画面方向。 vertical：竖屏； horizontal：横屏。
PosX	Float	`0`	水平偏移，表示水印左侧边与转码流画面左侧边之间的距离，使用相对比率，取值范围为 [0,1]
PosY	Float	`0`	垂直偏移，表示水印顶部边与转码流画面顶部边之间的距离，使用相对比率，取值范围为 [0,1]
RelativeWidth	Float	`1`	水印相对宽度，水印宽度占直播转码流画面宽度的比例，取值范围为 [0,1]，水印高度会随宽度等比缩放

WatermarkErrMsgList

参数	类型	示例值	描述
AccountID	String	`****1`	火山引擎账号 ID
Vhost	String	`push.example.com`	域名空间名称
App	String	`example_app`	应用名称
ErrMsg	String	`[ListVhostWatermarkPreset] fail to get picture from tos, app: testApp, err: internal error`	获取水印模板失败的具体错误信息

示例

请求示例

POST https://live.volcengineapi.com?Action=ListVhostWatermarkPreset&Version=2020-08-01
{
  "Vhost": "testVhost"
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "2021072818053901022706413520787",
    "Action": "ListVhostWatermarkPreset",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "WatermarkPresetList": [
      {
        "Vhost": "testVhost",
        "App": "testApp",
        "Orientation": "horizontal",
        "PosX": 0.1,
        "PosY": 0.1,
        "RelativeWidth": 0.185,
        "Picture": "data:image/png;base64,iVBORw0KGgoAA****kSuQmCC"
      }
    ],
    "WatermarkErrMsgList": [],
    "StaticsMsg": "successfully get all 1 watermark presets of current vhost"
  }
}

错误码

访问公共错误码获取详细信息。