Domain name for API request: vod.intl.tencentcloudapi.com.
Retrieve user-customized MPS task templates.
When querying the template list, require MPS related parameters to be filled in MPSDescribeTemplateParams in JSON format. For task parameter configuration method, refer to MPS task template document description.
A maximum of 20 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: DescribeMPSTemplates. |
| 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 | Yes | Integer | VOD application ID. |
| TemplateType | Yes | String | MPS template type. Filter results by the MPS template type you want to query. Value: |
| MPSDescribeTemplateParams | No | String | MPS queries template parameters. This parameter is used for passing through to the media processing service (MPS) to query the MPS template list from the VOD side. Currently only support querying templates of the following task types via this method: 1. Audio and video enhancement: Only support filling in the content of Definitions, Type, Name, Offset, and Limit parameters in the "retrieval transcoding template list" (https://www.tencentcloud.com/document/product/862/37593?from_cn_redirect=1) interface. Currently only support configuring the above parameters in template, other parameters not required. If other parameters are included, system will automatically ignore. 2. Intelligent Analysis: Only support filling in the content of Definitions, Type, Name, Offset, and Limit parameters from the "Search Intelligent Analysis Template List" (https://www.tencentcloud.com/document/product/862/40247?from_cn_redirect=1) interface. Currently only support configuring the above parameters in the Template. Other parameters are not required. If other parameters are included, the system will automatically ignore them. 3. Smart subtitling: Only supports filling in the content of Definitions, Type, Name, Offset, and Limit parameters from the "Get Smart Subtitling Template List" (https://www.tencentcloud.com/document/product/862/117002?from_cn_redirect=1) interface. Currently only support configuring the above parameters in template, other parameters not required. If other parameters are included, system will automatically ignore. 4. Intelligent erasure: Only supports filling in the content of Definitions, Type, Name, Offset, and Limit parameters in the "Search intelligent erasure template list" (https://www.tencentcloud.com/document/product/862/123733?from_cn_redirect=1) interface. Currently only support configuring the above parameters in template. Other parameters are not required. If other parameters are included, the system will automatically ignore. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of records that meet the filtering conditions. |
| MPSTemplateSet | Array of MPSTemplate | MPS task template details 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. |
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMPSTemplate
<Common request parameters>
{
"SubAppId": 1500000001,
"TemplateType": "Transcode",
"MPSDescribeTemplateParams": "{\"Definitions\": [100010],\"Type\": \"Custom\"}"
}
{
"Response": {
"TotalCount": 1,
"MPSTemplateSet": [
{
"TaskType": "Transcode",
"MPSTemplateInfo": "{\"Definition\":\"100010\",\"Container\":\"mp4\",\"Name\":\"test\",\"Comment\":\"\",\"Type\":\"Custom\",\"RemoveVideo\":0,\"RemoveAudio\":0,\"VideoTemplate\":{\"Codec\":\"h264\",\"Fps\":0,\"Bitrate\":0,\"ResolutionAdaptive\":\"open\",\"Width\":0,\"Height\":0,\"FillType\":\"black\",\"Gop\":0,\"VideoProfile\":\"\",\"VideoLevel\":\"\",\"Subjective\":0,\"ContentAdaptStream\":0,\"SegmentType\":0,\"FpsDenominator\":1,\"Stereo3dType\":\"\",\"HlsTime\":0,\"Mode\":\"VBR\",\"Sar\":\"\",\"NoScenecut\":0,\"BitDepth\":8,\"RawPts\":0,\"ScenarioBased\":0,\"SceneType\":\"\",\"CompressType\":\"\"},\"AudioTemplate\":{\"Codec\":\"aac\",\"Bitrate\":0,\"SampleRate\":44100,\"AudioChannel\":2,\"StreamSelects\":[]},\"ContainerType\":\"Video\",\"CreateTime\":\"2025-07-22T20:28:36+08:00\",\"UpdateTime\":\"2025-07-22T20:28:36+08:00\",\"TEHDConfig\":null,\"EnhanceConfig\":{\"VideoEnhance\":{\"FrameRate\":{\"Switch\":\"ON\",\"Fps\":0},\"SuperResolution\":{\"Switch\":\"ON\",\"Type\":\"hq\",\"Size\":2},\"Hdr\":{\"Switch\":\"OFF\",\"Type\":\"HDR10\"},\"Denoise\":{\"Switch\":\"OFF\",\"Type\":\"weak\"},\"ImageQualityEnhance\":{\"Switch\":\"ON\",\"Type\":\"normal\"},\"ColorEnhance\":{\"Switch\":\"ON\",\"Type\":\"weak\"},\"SharpEnhance\":{\"Switch\":\"OFF\",\"Intensity\":0},\"FaceEnhance\":{\"Switch\":\"OFF\",\"Intensity\":0},\"LowLightEnhance\":{\"Switch\":\"OFF\",\"Type\":\"normal\"},\"ScratchRepair\":{\"Switch\":\"OFF\",\"Intensity\":0},\"ArtifactRepair\":{\"Switch\":\"OFF\",\"Type\":\"weak\"}},\"AudioEnhance\":{\"Denoise\":{\"Switch\":\"OFF\"},\"Separate\":{\"Switch\":\"OFF\",\"Type\":\"normal\",\"Track\":\"vocal\"},\"VolumeBalance\":{\"Switch\":\"OFF\",\"Type\":\"loudNorm\"},\"Beautify\":{\"Switch\":\"OFF\",\"Types\":[\"declick\"]}}},\"StdExtInfo\":null,\"AliasName\":\"\"}"
}
],
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
}
}
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
| ResourceNotFound.TemplateNotExist | The resource does not exist: the template does not exist. |
文档反馈