文档中心 视频处理 API 文档 参数模板相关接口 获取指定时间点截图模板列表

获取指定时间点截图模板列表

最近更新时间:2019-08-27 20:16:13

1. 接口描述

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

查询指定时间点截图模板,支持根据条件,分页查询。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSnapshotByTimeOffsetTemplates
Version String 公共参数,本接口取值:2019-06-12
Region String 公共参数,本接口不需要传递此参数。
Definitions.N Array of Integer 指定时间点截图模板唯一标识过滤条件,数组长度限制:100。
Offset Integer 分页偏移量,默认值:0。
Limit Integer 返回记录条数,默认值:10,最大值:100。
Type String 模板类型过滤条件,可选值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。
  • 3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    SnapshotByTimeOffsetTemplateSet Array of SnapshotByTimeOffsetTemplate 指定时间点截图模板详情列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取指定时间点截图模板列表

    输入示例

    https://mps.tencentcloudapi.com/?Action=DescribeSnapshotByTimeOffsetTemplates
    &Definitions.0=10001
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 1,
        "SnapshotByTimeOffsetTemplateSet": [
          {
            "Definition": 10001,
            "Type": "Custom",
            "Name": "指定时间点截图模板1",
            "Comment": "",
            "CreateTime": "2018-10-01T10:00:00Z",
            "UpdateTime": "2018-10-01T10:00:00Z",
            "Format": "jpg",
            "Height": 540,
            "Width": 960
          }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
    InternalError 内部错误。