调用SubmitIProductionJob提交智能生产作业。
使用说明
使用本接口提交的作业是异步执行方式。作业添加到管道中调度排队和执行,可以调用查询智能生产作业接口查询作业执行结果,也可以使用异步的消息通知机制获取结果。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SubmitIProductionJob |
系统规定参数。取值:SubmitIProductionJob。 |
FunctionName | String | 是 | ImageCartoonize |
需要使用的算法功能名称。取值:
|
ModelId | String | 否 | null |
算法模型ID。如果为空,则选择对应功能的默认模型(此参数保持为空即可,一般无需传入,直接使用默认模型)。 |
JobParams | String | 是 | {"Model":"gif"} |
算法作业参数,JSON对象,不同算法对应参数内容不同。更多信息请参见智能生产接口参数补充说明。 |
ScheduleParams | String | 否 | null |
作业调度参数,设置任务调度配置(非必填,保持为空即可)。 |
NotifyUrl | String | 否 | mns://125340688170****.oss-cn-shanghai.aliyuncs.com/queues/example-pipeline |
Callback路径,目前仅支持MNS消息队列。消息队列的路径可以通过MNS控制台 > 队列列表 > 详情查看。 |
UserData | String | 否 | null |
用户业务数据,随回调信息回传给回调地址(非必填,保持为空即可)。 |
PipelineId | String | 否 | 39f8e0bc005e4f309379701645f4**** |
作业管道ID,可以通过MPS控制台 > 全局设置 > 管道获取。用于确认作业回调队列以及提供租户隔离能力。若不传,则使用默认管道,默认作业并发数10,不绑定消息通知。 |
Input | String | 否 | oss://example-****.oss-cn-shanghai.aliyuncs.com/example.mp4 |
输入文件的OSS Bucket(目前仅支持OSS路径,且OSS的地域需要与当前MPS所在地域保持一致),可以通过MPS控制台 > 媒体管理 > 媒体列表获取或OSS控制台选择对应的Bucke获取路径。 说明 由于算法不同,Input在某些场景下为必填项。请根据您的实际业务需要选择是否传入此参数。
|
Output | String | 否 | oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt |
输出文件的OSS Bucket(目前仅支持OSS路径),可以通过MPS控制台 > 媒体管理 > 媒体列表获取或OSS控制台选择对应的Bucke获取路径。OSS的地域需要与当前MPS所在地域保持一致。 说明 格式为:
oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt ,其中{source} 、{timestamp} 和{sequenceId} 为占位符,分别填充输入文件名、Unix时间戳和生成序号,占位符不必须,但对于多输出算法,比如智能封面等,需要注意加入序号占位符确保输出文件路径不重复,文件后缀名规则由用户自定义。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 5210DBB0-E327-4D45-ADBC-0B83C8796E26 |
请求ID。 |
JobId | String | 39f8e0bc005e4f309379701645f4**** |
作业ID。建议您保存此ID便于后续调用其他接口时使用。 |
Result | String | { "Code":"Success", "Details":[], "FunctionName":"ImageCartoonize", "JobId":"39f8e0bc005e4f309379701645f4****", "Message":"success", "State":"Success", "Type":"IProduction" } |
返回结果。不同算法返回结果不同,更多信息请参见智能生产接口参数补充说明。 |
示例
请求示例
http(s)://mts.cn-shanghai.aliyuncs.com/?Action=SubmitIProductionJob
&FunctionName=ImageCartoonize
&ModelId=null
&JobParams={"Model":"gif"}
&ScheduleParams=null
&NotifyUrl=mns://125340688170****.oss-cn-shanghai.aliyuncs.com/queues/example-pipeline
&UserData=null
&PipelineId=39f8e0bc005e4f309379701645f4****
&Input=oss://example-****.oss-cn-shanghai.aliyuncs.com/example.mp4
&Output=oss://example-****.oss-cn-shanghai.aliyuncs.com/iproduction/{source}-{timestamp}-{sequenceId}.srt
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SubmitIProductionJobResponse>
<RequestId>5210DBB0-E327-4D45-ADBC-0B83C8796E26</RequestId>
<JobId>39f8e0bc005e4f309379701645f4****</JobId>
<Result>{ "Code":"Success", "Details":[], "FunctionName":"ImageCartoonize", "JobId":"39f8e0bc005e4f309379701645f4****", "Message":"success", "State":"Success", "Type":"IProduction" }</Result>
</SubmitIProductionJobResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "5210DBB0-E327-4D45-ADBC-0B83C8796E26",
"JobId" : "39f8e0bc005e4f309379701645f4****",
"Result" : "{ \"Code\":\"Success\", \"Details\":[], \"FunctionName\":\"ImageCartoonize\", \"JobId\":\"39f8e0bc005e4f309379701645f4****\", \"Message\":\"success\", \"State\":\"Success\", \"Type\":\"IProduction\" }"
}
错误码
访问错误中心查看更多错误码。