You need to enable JavaScript to run this app.
导航
查询水印配置
最近更新时间:2024.05.10 16:59:54首次发布时间:2023.09.25 14:34:06

调用 ListWatermarkPreset 接口,查询单个水印配置的信息。

注意事项

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

请求说明

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

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListWatermarkPreset接口名称。当前 API 的名称为 ListWatermarkPreset
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
VhostStringtestVhost域名空间,即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,查看直播流使用的域名所属的域名空间。
AppStringlive应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。

返回参数

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

参数类型示例值描述
PresetObject of Preset-水印模板。

Preset

参数类型示例值描述
IDInteger****1水印配置的 ID。
AccountIDString****1火山引擎账号 ID。
VhostStringpush.example.com域名空间。
AppStringlive应用名称。
PictureStringdata:image/png;base64,iVBORw0KG\*\*\*\*SuQmCC水印图片编码字符串。
PictureKeyStringtesttesttest.png水印图片文件名。

Orientation

String

horizontal

需要添加水印的直播画面方向。

  • vertical:竖屏;
  • horizontal:横屏。
PosXFloat0.1水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1]。
PosYFloat0.1垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1]。
RelativeWidthFloat0.185水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。
PictureURLStringhttps://test-image.jpg水印图片对应的 HTTP 地址。与水印图片编码字符串字段二选一传入,同时传入时,以水印图片编码字符串参数为准。
PreviewHeightFloat1080水印图片预览背景高度,单位为 px。
PreviewWidthFloat1080水印图片预览背景宽度,单位为 px。
RelativeHeightFloat0.1水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。
StreamStringexample_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"
        }
    }
}

错误码

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

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

服务端 SDK

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