一、1. 接口描述
以该种方式发起的视频处理任务:
·任务状态及结果的查询仍在点播平台中完成,使用 DescribeTaskDetail 或 DescribeTasks 查询任务。
·相关功能的用量及账单将在 MPS 平台给出,因此在使用该功能前,首先需要在控制台开通 MPS 服务。开通方式见接入文档的前置操作部分。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:ProcessMediaByMPS。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| FileId | 是 | String | 媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。示例值:5285485487985271487 |
| SubAppId | 是 | Integer | 点播应用 ID。示例值:1500000001 |
| MPSProcessMediaParams | 否 | String | 可选参数,该参数用于透传至媒体处理服务(MPS),以便从云点播侧发起 MPS 视频处理任务。不同类型的视频处理参数详情请参考 使用MPS 媒体 AI 能力,可通过CreateMPSTemplate 接口创建自定义模板。示例值:{"AiAnalysisTask":{"Definition":25,"ExtendedParameter":""}} |
| AiAnalysisTask | 否 | MPSAiAnalysisTaskInput | 视频内容分析类型任务参数,MPSProcessMediaParams为空时有效。 |
| SmartSubtitlesTask | 否 | MPSSmartSubtitlesTaskInput | 智能字幕类型任务参数,MPSProcessMediaParams为空时有效。 |
| SmartEraseTask | 否 | MPSSmartEraseTaskInput | 智能擦除类型任务参数,MPSProcessMediaParams为空时有效。 |
| ExtInfo | 否 | String | 保留字段,特殊用途时使用。示例值:ExtInfo |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| TaskId | String | 任务 ID。示例值:125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、示例1 使用MPSProcessMediaParams参数发起智能分析任务
使用MPSProcessMediaParams参数发起智能分析任务
五、输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMediaByMPS
<公共请求参数>
{
"FileId": "966263619095884274",
"SubAppId": 221157,
"MPSProcessMediaParams": "{\"AiAnalysisTask\":{\"Definition\": 21,\"ExtendedParameter\":\"\"}}"
}
六、输出示例
{
"Response": {
"TaskId": "221157-ProcessMediaByMPS-c80d6b074ba566e4e4097bccc0044b9bt",
"RequestId": "4cc2a86b-7463-4ac2-9a32-e64882716f9e"
}
}
七、示例2 使用结构化参数发起智能分析任务
使用结构化参数发起智能分析任务
八、输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMediaByMPS
<公共请求参数>
{
"FileId": "966263619095884274",
"SubAppId": 221157,
"AiAnalysisTask": {
"Definition": 21,
"ExtendedParameter": ""
}
}
九、输出示例
{
"Response": {
"TaskId": "221157-ProcessMediaByMPS-fd5bcd2cf2195fda7c7b571aa18cb68dt",
"RequestId": "c8bbd537-0815-4123-b284-8c1ee856bbe8"
}
}
十、腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便你从同一入口查询及使用腾讯云提供的所有 API 服务。
十一、API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
十二、SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
十三、命令行工具
·Tencent Cloud CLI 3.0
十四、6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| FailedOperation | 操作失败。 |
| FailedOperation.InvalidVodUser | 没有开通点播业务。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.FileId | FileId 不存在。 |
| InvalidParameterValue.SessionContextTooLong | SessionContext 过长。 |
| InvalidParameterValue.SessionId | 去重识别码重复,请求被去重。 |
| InvalidParameterValue.SessionIdTooLong | SessionId 过长。 |
| InvalidParameterValue.SubAppId | 参数值错误:应用 ID。 |
| UnauthorizedOperation | 未授权操作。 |