DescribeAIAnalysisTemplates

Last updated: 2025-02-19 14:55:54Download PDF

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

This API is used to get the list of 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 Params. The value used for this API: DescribeAIAnalysisTemplates.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. 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: 10.
Offset	No	Integer	Pagination offset. Default value: 0.
Limit	No	Integer	Number of returned entries. Default value: 10. Maximum value: 100.
Type	No	String	The filter for querying templates. If this parameter is left empty, both preset and custom templates are returned. Valid values: * Preset * Custom
Name	No	String	Filter condition for video analysis template identifiers, with a length limit of 64 characters.

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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtaining a Specified Number of Video Analysis Templates

This example shows you how to obtain up to 10 video analysis templates, including default ones, starting from the first record (offset = 0).

Input Example

https://mps.intl.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",
                "Type": "Preset",
                "ClassificationConfigure": {
                    "Switch": "ON"
                },
                "TagConfigure": {
                    "Switch": "ON"
                },
                "CoverConfigure": {
                    "Switch": "ON"
                },
                "FrameTagConfigure": {
                    "Switch": "ON"
                },
                "CreateTime": "2019-01-01T12:00:00Z",
                "UpdateTime": "2019-01-01T16:00:00Z"
            },
            {
                "Definition": 31,
                "Name": "Template 2",
                "Type": "Preset",
                "Comment": "Intelligent Analysis Template",
                "ClassificationConfigure": {
                    "Switch": "OFF"
                },
                "TagConfigure": {
                    "Switch": "ON"
                },
                "CoverConfigure": {
                    "Switch": "ON"
                },
                "FrameTagConfigure": {
                    "Switch": "ON"
                },
                "CreateTime": "2019-01-01T13:00:00Z",
                "UpdateTime": "2019-01-01T17:00:00Z"
            }
        ],
        "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
    }
}

Example2 Obtaining a Video Analysis Template with ID 30

Input Example

https://mps.intl.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",
                "Type": "Preset",
                "ClassificationConfigure": {
                    "Switch": "ON"
                },
                "TagConfigure": {
                    "Switch": "ON"
                },
                "CoverConfigure": {
                    "Switch": "ON"
                },
                "FrameTagConfigure": {
                    "Switch": "ON"
                },
                "CreateTime": "2019-01-01T12:00:00Z",
                "UpdateTime": "2019-01-01T16:00:00Z"
            }
        ],
        "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameter	Parameter error.
LimitExceeded.TooMuchTemplate	Limit reached: the number of templates exceeds the limit.
ResourceNotFound	The resource does not exist.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.