帮你快速理解、总结文档立即下载

创建截图模板

最近更新时间:2026-10-13 02:47:40
我的收藏

1. 接口描述

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

创建截图模板

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:CreateVideoSnapshotTemplate。
Version 是 String 公共参数,本接口取值:2023-05-17。
Region 是 String 公共参数,详见产品支持的 地域列表。
Name 是 String

模板名称: 中文、英文、数字、“-”、“_” 长度不超过128个字符


示例值:实时截帧模板
Type 是 Integer

截图类型: 1-实时截帧 2-低频截帧
注意:实时截帧在生效时段期间一直拉取实时流, 低频截帧在生效时段期间按需拉取实时流,每次拉流的最短持续时间不低于1分钟

枚举值:

  • 1: 实时截帧
  • 2: 低频截帧

示例值:1
Interval 是 Integer

截帧频率: Type = 1时,取值[5, 180]秒 Type = 2时 取值[30, 36000]秒


示例值:120
Times.N 是 Array of EffectiveTime

生效时段,注:数组大小不超过100个且每个时间段不低于1分钟

MultiMode 否 MultiVideoSnapshotMode

多张模式

3. 输出参数

参数名称 类型 描述
Data VideoSnapshotTemplateInfo

截图模板信息

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功

实时截帧模板创建

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoSnapshotTemplate
<公共请求参数>

{
    "Name": "实时截帧模板",
    "Type": 1,
    "Interval": 120,
    "Times": [
        {
            "BeginTime": "9:00:00",
            "EndTime": "12:00:00",
            "WeekDay": 1
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "CreateTime": "2026-01-25 12:10:49",
            "Interval": 120,
            "MultiMode": {
                "Enable": false,
                "Interval": 0,
                "Total": 0
            },
            "Name": "实时截帧模板",
            "TemplateId": "b11*********e*******************48c4",
            "Times": [
                {
                    "BeginTime": "9:00:00",
                    "EndTime": "12:00:00",
                    "WeekDay": 1
                }
            ],
            "Type": 1,
            "UpdateTime": "2026-01-25 12:10:49"
        },
        "RequestId": "c8453e1b-2428-4ec3-bfee-3b6412b41de6"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InvalidParameterValue.ContainInvalidSnapshotTime 包含无效的截图时间段
InvalidParameterValue.InvalidName 名称为空或填写有误
InvalidParameterValue.UnsupportedInterval 不支持的截帧频率配置
InvalidParameterValue.UnsupportedSnapshotTotal 不支持的截帧张数配置
InvalidParameterValue.UnsupportedSnapshotType 不支持的截图类型
LimitExceeded.SnapshotTemplateNumExceeded 可创建的截图模板数量超限
LimitExceeded.TimelineSliceExceedLimit 时间段数量超出限制
UnsupportedOperation.ImageDomainNotExist 图片域名不存在