API概览

更新时间:
复制为 MD 格式

本产品(Mts/2014-06-18)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

媒体信息接口

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 媒体处理操作的文件资源均存放在OSSBucket中。将OSSBucket在媒体处理MPS中绑定为输入媒体Bucket、输出媒体Bucket后,媒体处理MPS才有权限监听该Bucket上传完成的消息,以实现触发工作流执行和处理完成的文件回写动作。您可以调用BindInputBucket接口绑定输入媒体Bucket。
BindOutputBucket 绑定输出媒体Bucket 媒体处理操作的文件资源均存放在OSSBucket中。将OSSBucket在媒体处理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概述

SubmitSmarttagJob 提交智能标签作业 提交智能标签作业。
QuerySmarttagJob 查询智能标签作业 查询智能标签作业。
AddSmarttagTemplate 添加模板 添加一个智能标签作业的分析模板。
QuerySmarttagTemplateList 查询模板 查询智能标签作业的分析模板。
UpdateSmarttagTemplate 更新模板 更新一个智能标签作业的分析模板。
DeleteSmarttagTemplate 删除模板 删除一个智能标签作业的分析模板。
RegisterCustomFace 注册⾃定义⼈脸 注册⼀张⾃定义⼈脸。
UnregisterCustomFace 注销⾃定义⼈脸 注销⼀张⾃定义⼈脸,或者注销某个⾃定义⼈物下的所有⼈脸。
TagCustomPerson 添加⾃定义⼈物库或⼈物标签 给⾃定义⼈物库或⼈物贴标签。
ListCustomPersons 列出⼈物库所有⼈物和⼈脸信息 列出指定⼈物库下的所有⼈物和⼈脸信息。
CreateCustomGroup 创建自定义库 创建自定义库。
CreateCustomEntity 创建自定义实体 创建相应自定义库中自定义实体。
RegisterCustomView 注册自定义实体照片 注册自定义实体照片。
DeleteCustomEntity 删除自定义库实体 删除自定义库实体。
DeleteCustomGroup 删除自定义库 删除自定义库。
DeleteCustomView 删除自定义实体照片 删除自定义实体照片。
ListCustomViews 获取自定义库实体不同view图片列表 获取自定义库实体不同view图片列表。
ListCustomEntities 获取自定义库下实体列表 获取自定义库下实体列表。
ListCustomGroups 获取自定义库列表 获取自定义库列表。

媒体审核接口

API

标题

API概述

SubmitMediaCensorJob 提交媒体审核作业 提交媒体审核作业。
QueryMediaCensorJobDetail 查询媒体审核作业详情 查询媒体审核作业的详细信息。
QueryMediaCensorJobList 查询媒体审核作业列表 查询媒体审核作业列表。
ImAudit 提交图文审核作业 进行图片、文本内容审核,审核结果同步返回。

视频DNA接口

API

标题

API概述

SubmitFpShotJob 提交DNA作业 查询DNA底库中是否存在相同或者相近的DNA结果。
QueryFpShotJobList 查询DNA作业结果 查询DNA作业结果,本接口支持查询所有类型的DNA作业结果。
CreateFpShotDB 创建DNA 提交新建DNA库作业。
ListFpShotDB 查询DNA 查询DNA库。
ImportFpShotJob 提交文本导库任务 提交文本导库任务。
ListFpShotFiles 查询DNA库文件列表 查询DNA库文件列表。
SubmitFpFileDeleteJob 提交删除DNA文件 提交删除DNA文件作业。
QueryFpFileDeleteJobList 查询删除DNA文件 查询删除DNA文件作业。
SubmitFpDBDeleteJob 提交删除DNA 提交删除DNA库作业。
QueryFpDBDeleteJobList 查询删除DNA 查询删除DNA库作业。
ListFpShotImportJob 查询文本导库作业 查询文本导库作业。

数字水印接口

API

标题

API概述

SubmitCopyrightJob 提交视频版权水印作业 调用SubmitCopyrightJob提交视频版权水印任务。
QueryCopyrightJob 查询视频版权水印作业 调用此接口查询视频版权水印作业。
SubmitTraceAbJob 提交视频溯源水印ab流作业 通过调用SubmitTraceAbJob接口提交视频溯源水印ab流任务。
QueryTraceAbJob 查询视频溯源水印ab流作业 调用此接口查询视频溯源水印ab流作业。
SubmitTraceM3u8Job 提交视频溯源水印m3u8作业 调用此接口提交视频溯源水印m3u8任务。
QueryTraceM3u8Job 查询视频溯源水印m3u8作业 调用此接口查询视频溯源水印m3u8作业。
SubmitCopyrightExtractJob 提交版权水印提取作业 调用此接口提交版权水印提取作业。
QueryCopyrightExtractJob 查询版权水印提取作业 调用此接口查询版权水印提取信息作业。
SubmitTraceExtractJob 提交溯源水印提取作业 调用此接口提交溯源水印提取作业。
QueryTraceExtractJob 查询溯源水印提取作业 调用此接口查询溯源水印提取作业信息。
SubmitImageCopyright 提交图片透明图水印 调用此接口提交生成图片透明图水印。