文档中心>API 中心>云点播>其他接口>获取 MPS 任务模板列表

获取 MPS 任务模板列表

最近更新时间:2025-09-12 04:15:27

我的收藏

1. 接口描述

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

获取用户自定义媒体处理服务(MPS)任务模板。
查询模板列表时,需要将 MPS 相关参数以 JSON 格式填入 MPSDescribeTemplateParams 参数中。关于具体的任务参数配置方法,请参考 MPS 任务模板相关文档说明。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMPSTemplates。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
SubAppId Integer 点播应用 ID。
示例值:1500000001
TemplateType String MPS 模板类型。根据需要查询的 MPS 模板的类型对结果进行过滤。取值:
  • Transcode: 查询转码模板列表。

  • 示例值:Transcode
    MPSDescribeTemplateParams String MPS 查询模板参数。该参数用于透传至媒体处理服务(MPS),从云点播侧查询 MPS 任务模板列表。目前仅支持通过此方式查询以下任务类型的模板:
    1. 音视频增强:仅支持填写“获取转码模板列表”接口中的 Definitions、Offset 和 Limit 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
    示例值:{"Limit": 10}

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    示例值:1
    MPSTemplateSet Array of MPSTemplate MPS 任务模板详情列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取 MPS 任务的参数模板列表

    输入示例

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeMPSTemplate
    <公共请求参数>
    
    {
        "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"
        }
    }

    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 资源不存在:模板不存在。