调用 ListWatermarkPreset 接口，查询单个水印配置的信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListWatermarkPreset | 接口名称。当前 API 的名称为 ListWatermarkPreset。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Vhost | String | 是 | testVhost | 域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的域名所属的域名空间。 |
| App | String | 是 | live | 应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。 |
Stream | String | 否 |
| 流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。 说明
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Preset | Object of Preset | - | 水印模板。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ID | Integer | ****1 | 水印配置的 ID。 |
| AccountID | String | ****1 | 火山引擎账号 ID。 |
| Vhost | String | push.example.com | 域名空间。 |
| App | String | live | 应用名称。 |
| Picture | String | data:image/png;base64,iVBORw0KG****SuQmCC | 水印图片编码字符串。 |
| PictureKey | String | testtesttest.png | 水印图片文件名。 |
Orientation | String |
| 需要添加水印的直播画面方向。
|
| PosX | Float | 0.1 | 水平偏移，表示水印左侧边与转码流画面左侧边之间的距离，使用相对比率，取值范围为 [0,1]。 |
| PosY | Float | 0.1 | 垂直偏移，表示水印顶部边与转码流画面顶部边之间的距离，使用相对比率，取值范围为 [0,1]。 |
| RelativeWidth | Float | 0.185 | 水印相对宽度，水印宽度占直播转码流画面宽度的比例，取值范围为 [0,1]，水印高度会随宽度等比缩放。 |
| PictureURL | String | https://test-image.jpg | 水印图片对应的 HTTP 地址。与水印图片编码字符串字段二选一传入，同时传入时，以水印图片编码字符串参数为准。 |
| PreviewHeight | Float | 1080 | 水印图片预览背景高度，单位为 px。 |
| PreviewWidth | Float | 1080 | 水印图片预览背景宽度，单位为 px。 |
| RelativeHeight | Float | 0.1 | 水印相对高度，水印高度占直播转码流画面高度的比例，取值范围为 [0,1]，水印宽度会随高度等比缩放。 |
| Stream | String | example_stream | 流名称。 |
POST https://live.volcengineapi.com?Action=ListWatermarkPreset&Version=2023-01-01 { "Vhost": "push.example.com", "App": "live" }
{ "ResponseMetadata": { "RequestID": "2021072818053901022706413520787", "Action": "ListWatermarkPreset", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" } "Result": { "Preset": { "ID": "****1", "AccountID": "****1", "Vhost":"push.example.com", "App":"live", "Orientation": "horizontal", "PosX": 0.1, "PosY": 0.1, "RelativeWidth": 0.185, "PictureKey": "testtesttest.png", "Picture": "data:image/png;base64,iVBORw0KG****SuQmCC" } } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 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，支持多种编程语言，帮助您更方便的调用 API。