Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to get the detail list of audio and video content analysis templates based on their unique identifiers. The returned results include all eligible user-defined audio and video content analysis templates and system preset audio/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 Params. The value used for this API: DescribeAIAnalysisTemplates. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| Definitions.N | No | Array of Integer | Filter condition for the unique identifier of the audio and video content analysis template. The array can contain up to 100 unique identifiers. |
| 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 | Total number of records that meet the filtering conditions. |
| AIAnalysisTemplateSet | Array of AIAnalysisTemplateItem | Audio and video content analysis template detail list. |
| 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. |
This example shows you how to obtain up to 10 audio/video content analysis templates, including default ones, starting from the first record (offset = 0).
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAIAnalysisTemplates
<Common request parameters>
{
"Limit": 10,
"Offset": 0
}{
"Response": {
"TotalCount": 2,
"AIAnalysisTemplateSet": [
{
"Definition": 30,
"Name": "Template 1",
"Comment": "Intelligent Analysis Template",
"ClassificationConfigure": {
"Switch": "ON"
},
"TagConfigure": {
"Switch": "ON"
},
"CoverConfigure": {
"Switch": "ON"
},
"HighlightConfigure": {
"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"
},
"TagConfigure": {
"Switch": "ON"
},
"CoverConfigure": {
"Switch": "ON"
},
"HighlightConfigure": {
"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"
}
}This example shows you how to get the information of up to 10 video analysis templates, including preset templates, starting from the first record (offset = 0).
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAIAnalysisTemplates
<Common request parameters>
{
"Definitions": [
30
]
}{
"Response": {
"TotalCount": 1,
"AIAnalysisTemplateSet": [
{
"Definition": 30,
"Name": "Template 1",
"Comment": "Intelligent Analysis Template",
"ClassificationConfigure": {
"Switch": "ON"
},
"TagConfigure": {
"Switch": "ON"
},
"CoverConfigure": {
"Switch": "ON"
},
"HighlightConfigure": {
"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"
}
}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 | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| LimitExceeded.TooMuchTemplate | Exceed the limit: The number of templates exceeds the upper limit of 100. For more, please submit a ticket (https://console.tencentcloud.com/workorder/category). |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.TemplateNotExist | Resource does not exist: template not found. |
| UnauthorizedOperation | Unauthorized operation. |
フィードバック