帮你快速理解、总结文档立即下载

修改 MPS 任务模板

最近更新时间:2026-08-03 03:14:26
我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

修改用户自定义 MPS 任务模板。
修改模板时,需要将 MPS 相关参数以 JSON 格式填入 MPSModifyTemplateParams 参数中。关于具体的任务参数配置方法,请参考 MPS 任务模板相关文档说明。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyMPSTemplate。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
SubAppId Integer

点播应用 ID。


示例值:1500000001
TemplateType String

需要修改的 MPS 模板的类型。

枚举值:

  • AIAnalysis: 智能分析模板
  • SmartSubtitle: 智能字幕模板
  • SmartErase: 智能擦除模板
  • EmbedSubtitle: 字幕压制模板

示例值:SmartSubtitle
MPSModifyTemplateParams String

MPS 修改模板参数。该参数用于透传至媒体处理服务(MPS),从云点播侧修改用户自定义的 MPS 任务模板。
目前仅支持通过此方式修改以下任务类型的模板:

  1. 音视频增强:仅支持填写“修改转码模板”接口中的 Name、Comment、RemoveVideo、RemoveAudio、VideoTemplate、AudioTemplate 和 EnhanceConfig 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
  2. 智能分析:仅支持填写“修改内容分析模板”接口中的Name、Comment、ClassificationConfigure、TagConfigure、CoverConfigure、FrameTagConfigure几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
  3. 智能字幕:仅支持填写“修改智能字幕模板”接口中的Name、Comment、TranslateSwitch、VideoSrcLanguage、SubtitleFormat、SubtitleType、AsrHotWordsConfigure、TranslateDstLanguage、ProcessType几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
  4. 智能擦除:仅支持填写“修改智能擦除模板”接口中的Name、Comment、EraseType、EraseSubtitleConfig、EraseWatermarkConfig、ErasePrivacyConfig几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。

示例值:{ "Definition": 30021, "TranslateSwitch": "ON", "Name": "SmartSubtitle", "VideoSrcLanguage": "zh", "TranslateDstLanguage": "en","SubtitleType": 1}
AIAnalysisTemplate MPSAIAnalysisTemplateForUpdate

智能分析模板参数,MPSModifyTemplateParams为空时有效。

SmartSubtitleTemplate MPSSmartSubtitleTemplateForUpdate

智能字幕模板参数,MPSModifyTemplateParams为空时有效。

SmartEraseTemplate MPSSmartEraseTemplateForUpdate

智能擦除模板参数,MPSModifyTemplateParams为空时有效。

EmbedSubtitleTemplate MPSEmbedSubtitleTemplateForUpdate

字幕压制模板参数,MPSModifyTemplateParams为空时有效。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改 MPS 音视频智能字幕模板

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMPSTemplate
<公共请求参数>

{
    "SubAppId": 221157,
    "TemplateType": "SmartSubtitle",
    "SmartSubtitleTemplate": {
        "Definition": 50023,
        "Name": "Template1",
        "Comment": "SmartSubtitle Template1",
        "SubtitleType": 0,
        "VideoSrcLanguage": "en",
        "SubtitleFormat": "vtt",
        "TranslateSwitch": "OFF",
        "ProcessType": 0
    }
}

输出示例

{
    "Response": {
        "RequestId": "0d54e984-91ba-4b2a-abb3-f417303bfd3a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。