tencent cloud

APIs

문서APIsVideo on DemandOther APIsDescribeMPSTemplates

DescribeMPSTemplates

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-09-18 16:50:23

1. API Description

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

Query a user-customized media processing service task template.
To query the template list, fill in the MPS related parameters in MPSDescribeTemplateParams in JSON format. For task parameter configuration, see the MPS task template documentation.

A maximum of 20 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: 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 type of MPS template you want to query. Parameter Value:

  • AIAnalysis: Intelligent analysis template.
  • SmartSubtitle: Intelligent subtitle template.
  • SmartErase: Intelligent erasure template.
  • EmbedSubtitle: Subtitle suppression template.
    		•
    MPSDescribeTemplateParams No String

    MPS query template parameter. This parameter is used to pass through to the media processing service (MPS) to query the MPS task template list from the VOD side. Currently, only the following task types are supported for querying templates in this way:

    1. Audio and video enhancement: only support filling in the content of the Definitions, Type, Name, Offset, and Limit parameters in the Get transcoding template list API. Currently, only the above parameters can be configured in the template. Other parameters are not required. If other parameters are included, the system will automatically ignore them.
    2. AI analysis: only support filling in the content of the Definitions, Type, Name, Offset, and Limit parameters in the Get intelligent analysis template list API. Currently, only the above parameters can be configured in the template. Other parameters are not required. If other parameters are included, the system will automatically ignore them.
    3. Intelligent caption: only support filling in the content of the Definitions, Type, Name, Offset, and Limit parameters in the Get intelligent caption template list API. Currently, only the above parameters can be configured in the template. Other parameters are not required. If other parameters are included, the system will automatically ignore them.
    4. Intelligent erasure: only support filling in the content of the Definitions, Type, Name, Offset, and Limit parameters in the Get intelligent erasure template list API. Currently, only the above parameters can be configured in the template. Other parameters are not required. If other parameters are included, the system will automatically ignore them.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer

    Total number of records that meet filter 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.

    4. Example

    Example1 Get the parameter template of a specified MPS task

    Input Example

    POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMPSTemplates
<Common request parameters>

{
    "SubAppId": 221157,
    "TemplateType": "SmartSubtitle"
}

    Output Example

    {
    "Response": {
        "MPSTemplateSet": [
            {
                "MPSTemplateInfo": "{\"Definition\":100,\"Name\":\"ASR_Chinese source video - Generate CN text\",\"Comment\":\"\",\"Type\":\"Preset\",\"AsrHotWordsConfigure\":{\"Switch\":\"OFF\",\"LibraryId\":\"\"},\"AsrHotWordsLibraryName\":\"\",\"VideoSrcLanguage\":\"zh\",\"SubtitleFormat\":\"vtt\",\"SubtitleType\":0,\"TranslateSwitch\":\"OFF\",\"TranslateDstLanguage\":\"\",\"CreateTime\":\"2025-03-12T19:32:31+08:00\",\"UpdateTime\":\"2025-12-15T10:39:15+08:00\",\"AliasName\":\"ASR_Generate_Chinese_Subtitle_For_Chinese_Video\",\"ProcessType\":0,\"SelectingSubtitleAreasConfig\":{},\"SubtitleEmbedId\":0,\"SpeakerMode\":0,\"SpeakerLabel\":0}",
                "TaskType": "SmartSubtitle"
            }
        ],
        "TotalCount": 99,
        "RequestId": "33deb599-d221-4bab-95c9-76a203a06d24"
    }
}

    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

    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
    InternalError Internal error.
    InvalidParameterValue Parameter value error.
    ResourceNotFound.TemplateNotExist Resource does not exist: template does not exist.
    이전 주제: DeleteMPSTemplate다음 주제: ModifyMPSTemplate

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백

    키워드로 검색
      Enter keywords to search documentation