文档

API概览

更新时间:
本产品(媒体处理/2014-06-18)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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媒体处理操作的文件资源均存放在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概述
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提交图片版权水印调用此接口提交图片平铺水印。