有奖征文:轻量对象存储LighthouseCOS用户实践> HOT

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

查询用户自定义水印模板,支持根据条件,分页查询。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWatermarkTemplates。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:123
Type String 水印类型过滤条件,可选值:
  • image:图片水印;
  • text:文字水印;
  • svg:SVG 水印。

  • 示例值:text
    Offset Integer 分页偏移量,默认值:0。
    示例值:0
    Definitions.N Array of Integer 水印模板唯一标识过滤条件,数组长度限制:100。
    示例值:["1001\n"]
    Limit Integer 返回记录条数
  • 默认值:10;
  • 最大值:100。

  • 示例值:20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    示例值:1
    WatermarkTemplateSet Array of WatermarkTemplate 水印模板详情列表。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取水印模板

    输入示例

    https://vod.tencentcloudapi.com/?Action=DescribeWatermarkTemplates
    &Definitions.0=1001
    &Offset=0
    &Limit=20
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "WatermarkTemplateSet": [
                {
                    "Definition": 1001,
                    "Type": "image",
                    "Name": "示例结构体待完善",
                    "Comment": "测试模板",
                    "XPos": "10%",
                    "YPos": "10%",
                    "ImageTemplate": {
                        "ImageUrl": "http://1256768367.vod2.myqcloud.com/8b0dd2b5vodcq1256768367/4d27b39f5285890783754292994/aa.jpeg",
                        "Width": "80%",
                        "Height": "80%",
                        "RepeatType": "repeat",
                        "Transparency": 0
                    },
                    "TextTemplate": {
                        "FontType": "arial.ttf",
                        "FontSize": "16px",
                        "FontColor": "0xFF0000",
                        "FontAlpha": 1
                    },
                    "CreateTime": "2018-10-01T10:00:00Z",
                    "UpdateTime": "2018-10-01T10:00:00Z"
                }
            ],
            "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.InvalidVodUser 没有开通点播业务。
    InternalError 内部错误。
    InvalidParameterValue.Definitions 参数错误:Definitions。
    InvalidParameterValue.Limit 参数错误:Limit。
    InvalidParameterValue.Type Type 参数值错误。
    ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。
    UnauthorizedOperation 未授权操作。