Domain name for API request: mps.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.
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: 2019-06-12. |
| 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: 10. |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
| 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. |
This example shows you how to get 10 video content analysis templates with the serial number starting from 0, including system default ones.
https://mps.tencentcloudapi.com/?Action=DescribeAIAnalysisTemplates
&Definitions.0=30
&<Public request parameter>{
"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"
},
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
}
],
"RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
}
}This example shows you how to get 10 video content analysis templates with the serial number starting from 0, including system default ones.
https://mps.tencentcloudapi.com/?Action=DescribeAIAnalysisTemplates
&Offset=0
&Limit=10
&<Public request parameter>{
"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"
},
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
},
{
"Definition": 31,
"Name": "Template 2",
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?