DescribeAIAnalysisTemplates

Last updated: 2021-01-21 11:42:26

1. API Description

Domain name for API request: vod.tencentcloudapi.com.

This API is used to get the list of video content analysis templates based on unique template ID. The returned result includes all eligible custom and preset video content analysis templates.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeAIAnalysisTemplates.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
Definitions.N No Array of Integer Unique ID filter of video content analysis templates. Array length limit: 100.
Offset No Integer Pagination offset. Default value: 0.
Limit No Integer Number of returned entries. Default value: 10. Maximum value: 100.
SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible entries.
AIAnalysisTemplateSet Array of AIAnalysisTemplateItem List of video content analysis template details.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the video content analysis template whose ID is 30

This example shows you how to get 10 video content analysis templates with the serial number starting from 0, including the system default one.

Input Example

https://vod.tencentcloudapi.com/?Action=DescribeAIAnalysisTemplates
&Definitions.0=30
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "AIAnalysisTemplateSet": [
      {
        "Definition": 30,
        "Name": "Template 1",
        "Comment": "Intelligent analysis template",
        "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"
  }
}

Example2 Getting a specified number of video content analysis templates

This example shows you how to get 10 video content analysis templates with the serial number starting from 0, including the system default one.

Input Example

https://vod.tencentcloudapi.com/?Action=DescribeAIAnalysisTemplates
&Offset=0
&Limit=10
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 2,
    "AIAnalysisTemplateSet": [
      {
        "Definition": 30,
        "Name": "Template 1",
        "Comment": "Intelligent analysis template",
        "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": "Template 2",
        "Comment": "Intelligent analysis template",
        "ClassificationConfigure": {
          "Switch": "OFF"
        },