调用SubmitAIImageJob接口提交AI图片处理任务。

使用说明

调用本接口处理AI图片后,可以通过GetAIImageJobs接口查询任务执行结果。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SubmitAIImageJob

系统规定参数。取值:SubmitAIImageJob

VideoId String 357a8748c5774*****89d2726e6436aa

视频ID。可通过以下方式获取:

  • 通过控制台上传的视频,可登录点播控制台,选择媒资库 > 音/视频查看视频ID。
  • 通过CreateUploadVideo接口上传视频时,视频ID为返回参数VideoId的值。
  • 视频上传后,可通过SearchMedia接口查询视频ID,为请求后返回参数VideoId的值。
AITemplateId String ef1a8842cb9f*****cea80cad902e416

AI图片模板ID。可通过以下方式获取:

  • 通过AddAITemplate接口创建图片模板时,返回参数TemplateId的值。
  • 模板创建后,可通过ListAITemplate接口查询AI图片模板ID,为请求后返回参数TemplateId的值。
UserData String {"Extend":{"localId":"****","test":"www"}}

自定义设置。

  • 必须是JSON字符串。
  • 需要包含MessageCallback或者Extend参数。
  • 最大长度为512个字节。

参数构造详情,请参见UserData

AIPipelineId String 6492025b8f*****6ba5bb755a33438

AI任务管道ID。

说明 有默认ID,可不填写。如果需要批量导入,需要使用单独的任务管道,请提交工单联系阿里云售后团队进行配置。

返回数据

名称 类型 示例值 描述
JobId String cf08a2c6e11e*****de1711b738b9067

AI图片处理任务ID。

RequestId String 218A6807-A21E-43*****54-C0512880B0B0

请求ID。

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=SubmitAIImageJob
&VideoId=357a8748c5774*****89d2726e6436aa
&AITemplateId=ef1a8842cb9f*****cea80cad902e416
&UserData={"Extend":{"localId":"****","test":"www"}}
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SubmitAIImageJobResponse>
    <JobId>cf08a2c6e11e*****de1711b738b9067</JobId>
    <RequestId>218A6807-A21E-43*****54-C0512880B0B0</RequestId>
</SubmitAIImageJobResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "JobId" : "cf08a2c6e11e*****de1711b738b9067",
  "RequestId" : "218A6807-A21E-43*****54-C0512880B0B0"
}

错误码

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

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: