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

截图模板列表

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

1. 接口描述

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

获取截图模板详情列表

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

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

2. 输入参数

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

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

模板名称


示例值:test2
Type 否 Integer

截图类型

枚举值:

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

示例值:1
Sort 否 String

排序参数

默认值:update_time


示例值:update_time
Order 否 String

排序顺序

枚举值:

  • desc: 降序
  • asc: 生序

默认值:desc


示例值:desc
PageNumber 否 Integer

页码

默认值:1


示例值:1
PageSize 否 Integer

每页数目

默认值:20


示例值:20

3. 输出参数

参数名称 类型 描述
Data ListVideoSnapshotTemplateData

截图模板结果列表

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

4. 示例

示例1 成功

输入示例

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

{
    "Sort": "update_time",
    "Order": "desc",
    "PageNumber": 1,
    "PageSize": 20
}

输出示例

{
    "Response": {
        "Data": {
            "List": [
                {
                    "CreateTime": "2026-01-25 12:15:00",
                    "Interval": 3600,
                    "MultiMode": {
                        "Enable": true,
                        "Interval": 180,
                        "Total": 5
                    },
                    "Name": "低频截帧模板",
                    "TemplateId": "035f4**************8*******c1ca5aa4a",
                    "Times": [
                        {
                            "BeginTime": "9:00:00",
                            "EndTime": "12:00:00",
                            "WeekDay": 2
                        }
                    ],
                    "Type": 2,
                    "UpdateTime": "2026-01-25 12:15:00"
                }
            ],
            "Order": "desc",
            "PageNumber": 1,
            "PageSize": 20,
            "Sort": "update_time",
            "TotalCount": 2
        },
        "RequestId": "af39813c-96eb-4c48-b07f-1b31cfe5a9d3"
    }
}

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.PageSizeExceedLimit 页面大小超出限制
InvalidParameterValue.UnsupportedSnapshotType 不支持的截图类型
InvalidParameterValue.UnsupportedSortRule 不支持的排序规则
ResourceNotFound 资源不存在