文档

SubmitAIImageJob - 提交AI图片任务

更新时间:

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

接口说明

  • 目前本接口支持的服务地域:华北 2(北京)华东 2(上海)
  • 调用本接口处理 AI 图片后,可以通过 GetAIImageJobs 接口查询任务执行结果。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:SubmitAIImageJobWrite
  • 全部资源
    *

请求参数

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

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

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

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

  • 通过 AddAITemplate 接口创建图片模板时,返回参数 TemplateId 的值。
  • 模板创建后,可通过 ListAITemplate 接口查询 AI 图片模板 ID,为请求后返回参数 TemplateId 的值。
ef1a8842cb9f*****cea80cad902e416
UserDatastring

自定义设置。

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

参数构造详情,请参见 UserData

{"Extend":{"localId":"****","test":"www"}}
AIPipelineIdstring

AI 任务管道 ID。

说明 有默认 ID,可不填写。如果需要批量导入,需要使用单独的任务管道,请填写宜搭信息申请配置或联系阿里云售后进行配置。
6492025b8f*****6ba5bb755a33438

返回参数

名称类型描述示例值
object

返回结果。

JobIdstring

AI 图片处理任务 ID。

cf08a2c6e11e*****de1711b738b9067
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

  • 本页导读 (1)
文档反馈