文档

SubmitIProductionJob - 提交智能生产作业

更新时间:

提交智能生产作业。

接口说明

使用本接口提交的作业是异步执行方式。作业添加到管道中调度排队和执行,可以调用查询智能生产作业接口查询作业执行结果,也可以使用异步的消息通知机制获取结果。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
FunctionNamestring

功能算法名称。各功能算法支持的地域请参见服务地域。取值:

  • VideoH2V:视频横转竖

  • VideoDelogo:视频去图标

  • Cover:智能封面

  • VideoClip:视频摘要

  • ImageH2V:横转竖

  • ImageDelogo:图片去图标

  • CaptionExtraction:字幕提取(算法输入待处理视频的 URL,输出提取的字幕文件)

  • VideoDetext:视频去字幕

  • VideoGreenScreenMatting:绿幕抠图(算法输入待抠图视频的 URL 和替换的背景图片 URL,输出合成后的视频)

  • MusicSegmentDetect:副歌检测(输入待处理音频、视频的 URL,输出检测出的每一段副歌的起止时间,若检测不到副歌,则返回为空)

  • AudioMixing:混音处理

  • AudioBeatDetection:节奏检测(输入待处理音频、视频的 URL,输出检测出的节拍时间列表 BeatList 和强拍时间列表 DownBeatList)

  • ImageCartoonize:3D 风格、人脸风格化(如需使用人脸风格化的功能请联系钉钉号:yuanzhigao1209 对接)

  • AudioQualityAssessment:音质检测

  • FaceBeauty:视频美颜

  • SpeechDenoise:智能降噪

    说明 音质检测输入音频支持 16bit 量化的 WAV 音频文件,支持单双声道,支持的采样率范围为 8000~48000Hz。
ImageCartoonize
ModelIdstring

算法模型 ID。如果为空,则选择对应功能的默认模型(此参数保持为空即可,一般无需传入,直接使用默认模型)。

null
JobParamsstring

算法作业参数,JSON 对象,不同算法对应参数内容不同。更多信息请参见智能生产接口参数补充说明

{"Model":"gif"}
ScheduleParamsstring

作业调度参数,设置任务调度配置(非必填,保持为空即可)。

null
NotifyUrlstring

Callback 路径,目前仅支持 MNS 消息队列。消息队列的路径可以通过 MNS 控制台 > 队列列表 > 详情查看。

mns://125340688170****.mns.cn-beijing.aliyuncs.com/queues/example-pipeline
UserDatastring

用户业务数据,随回调信息回传给回调地址(非必填,保持为空即可)。

null
PipelineIdstring

作业管道 ID,可以通过 MPS 控制台 > 全局设置 > 管道获取。用于确认作业回调队列以及提供租户隔离能力。若不传,则使用默认管道,默认作业并发数 10,不绑定消息通知。

39f8e0bc005e4f309379701645f4****
Inputstring

输入文件的 OSS Bucket(目前仅支持 OSS 路径,且 OSS 的地域需要与当前 MPS 所在地域保持一致),可以通过 MPS 控制台 > 媒体管理 > 媒体列表获取或 OSS 控制台选择对应的 Bucke 获取路径。

说明 由于算法不同,Input 在某些场景下为必填项。请根据您的实际业务需要选择是否传入此参数。
oss://example-****.oss-cn-shanghai.aliyuncs.com/example.mp4
Outputstring

输出文件的 OSS Bucket(目前仅支持 OSS 路径),可以通过 MPS 控制台 > 媒体管理 > 媒体列表获取或 OSS 控制台选择对应的 Bucke 获取路径。OSS 的地域需要与当前 MPS 所在地域保持一致。

说明 格式为:oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt,其中{source}{timestamp}{sequenceId}为占位符,分别填充输入文件名、Unix 时间戳和生成序号,占位符不必须,但对于多输出算法,比如智能封面等,需要注意加入序号占位符确保输出文件路径不重复,文件后缀名规则由用户自定义。
oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

5210DBB0-E327-4D45-ADBC-0B83C8796E26
JobIdstring

作业 ID。建议您保存此 ID 便于后续调用其他接口时使用。

39f8e0bc005e4f309379701645f4****
Resultstring

返回结果。不同算法返回结果不同,更多信息请参见智能生产接口参数补充说明

{ "Code":"Success", "Details":[], "FunctionName":"ImageCartoonize", "JobId":"39f8e0bc005e4f309379701645f4****", "Message":"success", "State":"Success", "Type":"IProduction" }

示例

正常返回示例

JSON格式

{
  "RequestId": "5210DBB0-E327-4D45-ADBC-0B83C8796E26",
  "JobId": "39f8e0bc005e4f309379701645f4****",
  "Result": "{ \"Code\":\"Success\", \"Details\":[], \"FunctionName\":\"ImageCartoonize\", \"JobId\":\"39f8e0bc005e4f309379701645f4****\", \"Message\":\"success\", \"State\":\"Success\", \"Type\":\"IProduction\" }"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈