文档

GetAIImageJobs - 查询AI图片任务列表

更新时间:

调用GetAIImageJobs查询AI图片任务列表。

接口说明

  • 目前本接口支持的服务地域:华北 2(北京)华东 2(上海)
  • 先通过 SubmitAIImageJob 接口提交 AI 图片处理任务,再调用本接口查询 AI 图片任务列表信息。
  • 本接口一次最多可查询 10 个 AI 图片处理任务。

调试

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

授权信息

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

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

请求参数

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

AI 图片处理任务 ID。由一个或多个 JobId 组成,JobId 为调用 SubmitAIImageJob 接口返回参数 JobId 的值。

  • 最多支持 10 个 ID。
  • 多个 ID 之间使用半角逗号(,)分隔。
cf08a2c6e11e*****de1711b738b9067

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

7721B494-1F78-4E*****E8-A7CEE7315BFA
AIImageJobListobject []

AI 图片处理任务列表。

Statusstring

任务状态:

  • success:成功。
  • fail:失败。
success
CreationTimestring

AI 图片处理任务的创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2020-10-15T03:30:03Z
AIImageResultstring

AI 图片的 OSS 地址。

说明 为任务结果,因此该地址不提供完整的鉴权信息,需要鉴权信息需用户生成或者调用 ListAIImage 接口获取媒资结果。
[{"Score":5.035636554444242,"Url":"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif"}]
VideoIdstring

视频 ID。

357a8748c577*****789d2726e6436aa
JobIdstring

AI 图片处理任务 ID。

cf08a2c6e11e*****de1711b738b9067
UserDatastring

自定义设置。

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

参数构造详情,请参见 UserData

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

错误码。

Success
Messagestring

错误信息。

success
TemplateConfigstring

提交任务时,对指定模板的配置信息的快照。

{"Format":"gif","SetDefaultCover":"true"}
TemplateIdstring

AI 模板 ID。

5a86a00f15194*****d7fe7de1b4a173

示例

正常返回示例

JSON格式

{
  "RequestId": "7721B494-1F78-4E*****E8-A7CEE7315BFA",
  "AIImageJobList": [
    {
      "Status": "success",
      "CreationTime": "2020-10-15T03:30:03Z",
      "AIImageResult": "[{\"Score\":5.035636554444242,\"Url\":\"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif\"}]",
      "VideoId": "357a8748c577*****789d2726e6436aa",
      "JobId": "cf08a2c6e11e*****de1711b738b9067",
      "UserData": "{\"Extend\":{\"localId\":\"****\",\"test\":\"www\"}}",
      "Code": "Success",
      "Message": "success",
      "TemplateConfig": "{\"Format\":\"gif\",\"SetDefaultCover\":\"true\"}",
      "TemplateId": "5a86a00f15194*****d7fe7de1b4a173"
    }
  ]
}

错误码

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

  • 本页导读 (1)