API标准及多语言预置SDK
本产品(媒体处理/2014-06-18)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明。我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。自定义签名场景
若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。
媒体信息接口
| API | 标题 | API概述 |
|---|---|---|
| SubmitMediaInfoJob | 提交媒体信息作业 | 提交媒体信息作业。调用本接口之后媒体处理MPS会对输入文件进行媒体信息分析,返回输入文件的媒体信息。 |
| QueryMediaInfoJobList | 查询媒体信息作业信息 | 查询媒体信息作业。 |
转码接口
| API | 标题 | API概述 |
|---|---|---|
| SubmitJobs | 提交转码作业 | 提交转码作业。当控制台创建的转码任务和工作流均无法满足您的使用场景时,可以按需调用SubmitJobs接口进行转码。根据您的业务逻辑配置所需的转码参数即可。 |
| CancelJob | 取消转码作业 | 取消转码作业。 |
| QueryJobList | 查询转码作业 | 通过转码作业ID,批量查询转码作业。 |
| ListJob | 遍历转码作业 | 遍历转码作业。 |
预置智能模板推荐接口
| API | 标题 | API概述 |
|---|---|---|
| SubmitAnalysisJob | 提交预置模板分析作业 | 提交预置模板分析作业。 |
| QueryAnalysisJobList | 查询模板分析作业 | 查询模板分析作业,模板分析作业完成后,返回可用的预置模板列表。 |
自定义转码模板接口
| API | 标题 | API概述 |
|---|---|---|
| AddTemplate | 新增自定义转码模版 | 创建自定义模板,包含容器信息,视频跟音频流等设置。 |
| UpdateTemplate | 更新自定义转码模版 | 更新自定义转码模板设置。 |
| QueryTemplateList | 通过自定义模版ID查询转码模板详情 | 查询转码模板详细信息。 |
| SearchTemplate | 搜索自定义转码模板 | 搜索指定状态的自定义模板。 |
| DeleteTemplate | 删除自定义转码模板 | 删除自定义模板。 |
水印模板接口
| API | 标题 | API概述 |
|---|---|---|
| AddWaterMarkTemplate | 新增水印模版 | 创建水印模板。 |
| DeleteWaterMarkTemplate | 删除水印模板 | 删除水印模板。 |
| UpdateWaterMarkTemplate | 更新水印模版 | 更新指定水印模板的名称、配置。 |
| SearchWaterMarkTemplate | 搜索水印模板 | 搜索水印模板。 |
| QueryWaterMarkTemplateList | 通过水印模板ID查询水印模板详情 | 查询水印模板。 |
截图接口
| API | 标题 | API概述 |
|---|---|---|
| SubmitSnapshotJob | 提交截图作业 | 提交截图作业。调用本接口之后媒体处理MPS会对输入文件进行截图和拼图。 |
| QuerySnapshotJobList | 查询截图作业结果 | 查询截图作业。 |
管道接口
| API | 标题 | API概述 |
|---|---|---|
| UpdatePipeline | 更新管道:名称、状态及通知设定 | 更新管道。 |
| QueryPipelineList | 查询管道 | 通过管道ID查询管道。 |
| SearchPipeline | 搜索管道 | 通过管道状态搜索管道。 |
| AddPipeline | 添加管道 | 新增一个管道。 |
| DeletePipeline | 删除管道 | 删除管道。 |
媒体工作流接口
| API | 标题 | API概述 |
|---|---|---|
| AddMediaWorkflow | 新增媒体工作流 | 新增媒体工作流。 |
| ActivateMediaWorkflow | 激活媒体工作流 | 激活媒体工作流。 |
| DeactivateMediaWorkflow | 停用媒体工作流 | 停用媒体工作流。 |
| DeleteMediaWorkflow | 删除媒体工作流 | 删除媒体工作流。 |
| UpdateMediaWorkflow | 更新媒体工作流的拓扑结构 | 更新媒体工作流。 |
| QueryMediaWorkflowList | 查询已注册媒体工作流 | 查询已注册的媒体工作流。 |
| SearchMediaWorkflow | 搜索媒体工作流 | 搜索媒体工作流。 |
| UpdateMediaWorkflowTriggerMode | 更新媒体工作流的触发模式状态 | 更新媒体工作流的触发模式。 |
媒体工作流执行实例接口
| API | 标题 | API概述 |
|---|---|---|
| QueryMediaWorkflowExecutionList | 查询媒体工作流执行实例 | 查询媒体工作流执行实例。 |
| ListMediaWorkflowExecutions | 遍历媒体工作流执行实例 | 遍历媒体工作流执行实例。 |
媒体Bucket接口
| API | 标题 | API概述 |
|---|---|---|
| BindInputBucket | 媒体库绑定输入Bucket | 媒体处理操作的文件资源均存放在OSS的Bucket中。将OSS的Bucket在媒体处理MPS中绑定为输入媒体Bucket、输出媒体Bucket后,媒体处理MPS才有权限监听该Bucket上传完成的消息,以实现触发工作流执行和处理完成的文件回写动作。您可以调用BindInputBucket接口绑定输入媒体Bucket。 |
| BindOutputBucket | 绑定输出媒体Bucket | 媒体处理操作的文件资源均存放在OSS的Bucket中。将OSS的Bucket在媒体处理MPS中绑定为输入媒体Bucket、输出媒体Bucket后,媒体处理MPS才有权限监听该Bucket上传完成的消息,以实现触发工作流执行和处理完成的文件回写动作。您可以调用BindOutputBucket接口绑定输出媒体Bucket。 |
| UnbindInputBucket | 媒体库解绑输入Bucket | 解绑输入媒体Bucket。 |
| UnbindOutputBucket | 解绑输出Bucket | 解绑输出媒体Bucket。 |
| ListAllMediaBucket | 查询媒体Bucket | 列出媒体库所有媒体Bucket。 |
媒体接口
| API | 标题 | API概述 |
|---|---|---|
| AddMedia | 新增媒体 | 提交新增媒体作业。 |
| DeleteMedia | 删除媒体 | 删除媒体。 |
| UpdateMedia | 更新媒体基本信息 | 更新媒体基本信息。 |
| UpdateMediaCategory | 更新媒体类目 | 更新媒体类目。 |
| UpdateMediaCover | 更新媒体封面 | 更新媒体封面。 |
| AddMediaTag | 新增媒体标签 | 调用AddMediaTag接口为媒体文件添加单个标签。 |
| DeleteMediaTag | 更新媒体-删除标签 | 删除媒体标签。 |
| UpdateMediaPublishState | 更新媒体发布状态 | 更新媒体发布状态。 |
| QueryMediaList | 查询媒体列表 | 使用媒体ID查询媒体。 |
| QueryMediaListByURL | 通过媒体的输入地址进行媒体信息的查询 | 使用OSS文件地址查询媒体。 |
智能生产接口
| API | 标题 | API概述 |
|---|---|---|
| QueryIProductionJob | 查询智能生产作业 | 查询智能生产作业。 |
| SubmitIProductionJob | 提交智能生产作业 | 提交智能生产作业。 |
媒体审核接口
| API | 标题 | API概述 |
|---|---|---|
| SubmitMediaCensorJob | 提交媒体审核作业 | 提交媒体审核作业。 |
| QueryMediaCensorJobDetail | 查询媒体审核作业详情 | 查询媒体审核作业的详细信息。 |
| QueryMediaCensorJobList | 查询媒体审核作业列表 | 查询媒体审核作业列表。 |
视频DNA接口
| API | 标题 | API概述 |
|---|---|---|
| SubmitFpShotJob | 提交DNA作业 | 查询DNA底库中是否存在相同或者相近的DNA结果。 |
| QueryFpShotJobList | 查询DNA作业结果 | 查询DNA作业结果,本接口支持查询所有类型的DNA作业结果。 |
| CreateFpShotDB | 创建DNA库 | 提交新建DNA库作业。 |
| ListFpShotDB | 查询DNA库 | 查询DNA库。 |
| SubmitFpFileDeleteJob | 提交删除DNA文件 | 提交删除DNA文件作业。 |
| QueryFpFileDeleteJobList | 查询删除DNA文件 | 查询删除DNA文件作业。 |
| SubmitFpDBDeleteJob | 提交清空或删除DNA库 | 提交清空或删除DNA库作业。 |
| QueryFpDBDeleteJobList | 查询清空或删除DNA库 | 查询清空或删除DNA库作业。 |