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

更新截图配置

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

1. 接口描述

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

更新截图配置

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

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

2. 输入参数

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

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

截图配置Id


示例值:b8a****9****fd74
Name 否 String

截图配置名称

入参限制:中文、英文、数字、“-”、“_” 长度不超过128个字符


示例值:截图配置1
TemplateId 否 String

截图模板Id


示例值:144d81a1-70a4-4d30-a82a-0793ed07f3d3
FileExpires 否 Integer

图片文件的热存储天数

枚举值:

  • 7: 7天
  • 15: 15天
  • 30: 30天
  • 60: 60天
  • 90: 90天
  • 180: 180天
  • 270: 270天
  • 360: 360天
  • 540: 540天
  • 720: 720天
  • 900: 900天
  • 1080: 1080天

示例值:15
Callback 否 CallbackURL

回调配置

3. 输出参数

参数名称 类型 描述
Data VideoSnapshotConfigInfo

截图配置信息

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

4. 示例

示例1 成功

输入示例

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

{
    "ConfigId": "b8a************9****************fd74",
    "Name": "截图配置1",
    "FileExpires": 15
}

输出示例

{
    "Response": {
        "Data": {
            "Callback": {
                "Token": "",
                "Url": "http:***********************back"
            },
            "ConfigId": "b8a*************************7****d**",
            "CreateTime": "2026-01-25 14:55:34",
            "FileExpires": 15,
            "Name": "截图配置1",
            "TemplateId": "144****1*7*****************3ed**f3d3",
            "Type": 1,
            "UpdateTime": "2026-01-25 14:55:34"
        },
        "RequestId": "898d2032-7859-4f12-b41f-f1d2042b9b02"
    }
}

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.ContainInvalidToken 包含无效的Token
InvalidParameterValue.InvalidCallbackUrl 无效的回调地址
InvalidParameterValue.InvalidConfigId 无效的配置ID
InvalidParameterValue.InvalidName 名称为空或填写有误
InvalidParameterValue.InvalidTemplateId 无效的模板ID
InvalidParameterValue.UnsupportedFileExpireTime 不支持的文件存储过期时间
LimitExceeded.SnapshotConfigNumExceeded 可创建的截图配置数量超限
OperationDenied.ConfigChanging 配置正在变更中,请稍后重试
ResourceNotFound 资源不存在
ResourceNotFound.SnapshotConfigNotExist 截图配置不存在