文档中心

查询水印列表

最近更新时间：2023.12.29 17:59:27

首次发布时间：2023.09.25 14:34:06

调用 ListVhostWatermarkPreset 接口，查询指定域名空间的水印配置。

注意事项

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

请求说明

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

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListVhostWatermarkPreset`	接口名称。当前 API 的名称为 `ListVhostWatermarkPreset`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-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]，水印高度会随宽度等比缩放。
PictureURL	String	`https://test-image.jpg`	水印图片对应的 HTTP 地址。与水印图片字符串字段二选一传入，同时传入时，以水印图片字符串参数为准。
PreviewHeight	Float	`1080`	水印图片预览背景高度，单位为 px。
PreviewWidth	Float	`1920`	水印图片预览背景宽度，单位为 px。
RelativeHeight	Float	`0.1`	水印相对高度，水印高度占直播转码流画面高度的比例，取值范围为 [0,1]，水印宽度会随高度等比缩放。
Stream	String	`test-stream`	流名称。

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=2023-01-01
{
  "Vhost": "testVhost"
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "2021072818053901022706413520787",
    "Action": "ListVhostWatermarkPreset",
    "Version": "2023-01-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"
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
404	ResourceNotFound.PresetNotExist	preset not found	未找到配置模版。请检查传入的配置模版与创建好的配置模板是否一致。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
500	InternalError.Preset	an internal error related to preset occurred, please contact the administrator.	出现与功能配置相关的内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。