获取视频内容分析模板列表

最近更新时间:2019-04-30 14:38:03

1. 接口描述

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

根据视频内容分析模板唯一标识,获取视频内容分析模板详情列表。返回结果包含符合条件的所有用户自定义视频内容分析模板及[系统预置视频内容分析模板]

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAIAnalysisTemplates
Version String 公共参数,本接口取值:2018-07-17
Region String 公共参数,本接口不需要传递此参数。
Definitions.N Array of Integer 视频内容分析模板唯一标识过滤条件,数组长度限制:10。
Offset Integer 分页偏移量,默认值:0。
Limit Integer 返回记录条数,默认值:10,最大值:100。
SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合过滤条件的记录总数。
AIAnalysisTemplateSet Array of AIAnalysisTemplateItem 视频内容分析模板详情列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取模板 ID 为 30 的视频内容分析模板

输入示例

https://vod.tencentcloudapi.com/?Action=DescribeAIAnalysisTemplates
&Definitions.0=30
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "AIAnalysisTemplateSet": [
      {
        "Definition": 30,
        "Name": "模板1",
        "Comment": "智能分析模板",
        "ClassificationConfigure": {
          "Switch": "ON"
        },
        "TagConfigure": {
          "Switch": "ON"
        },
        "CoverConfigure": {
          "Switch": "ON"
        },
        "FrameTagConfigure": {
          "Switch": "ON",
          "ScreenshotInterval": 1
        },
        "CreateTime": "2019-01-01T12:00:00Z",
        "UpdateTime": "2019-01-01T16:00:00Z"
      }
    ],
    "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
  }
}

示例2 获取指定个数的视频内容分析模板

指定从序号 0 开始,总共 10 个视频内容分析模板,包括系统默认视频内容分析模板。

输入示例

https://vod.tencentcloudapi.com/?Action=DescribeAIAnalysisTemplates
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 2,
    "AIAnalysisTemplateSet": [
      {
        "Definition": 30,
        "Name": "模板1",
        "Comment": "智能分析模板",
        "ClassificationConfigure": {
          "Switch": "ON"
        },
        "TagConfigure": {
          "Switch": "ON"
        },
        "CoverConfigure": {
          "Switch": "ON"
        },
        "FrameTagConfigure": {
          "Switch": "ON",
          "ScreenshotInterval": 1
        },
        "CreateTime": "2019-01-01T12:00:00Z",
        "UpdateTime": "2019-01-01T16:00:00Z"
      },
      {
        "Definition": 31,
        "Name": "模板2",
        "Comment": "智能分析模板",
        "ClassificationConfigure": {
          "Switch": "OFF"
        },
        "TagConfigure": {
          "Switch": "ON"
        },
        "CoverConfigure": {
          "Switch": "ON"
        },
        "FrameTagConfigure": {
          "Switch": "ON",
          "ScreenshotInterval": 1
        },
        "CreateTime": "2019-01-01T13:00:00Z",
        "UpdateTime": "2019-01-01T17:00:00Z"
      }
    ],
    "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
LimitExceeded.TooMuchTemplate 超过限制值:模板数超限。
ResourceNotFound 资源不存在。
ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。