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

使用说明

先通过SubmitAIImageJob接口提交AI图片处理任务，再调用本接口查询AI图片任务列表信息。本接口一次最多可查询10个AI图片处理任务。

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值：GetAIImageJobs。

JobIds String 是 cf08a2c6e11e*****de1711b738b9067

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

  • 最多支持10个ID。
  • 多个ID之间使用半角逗号（,）分隔。

返回数据

名称 类型 示例值 描述
RequestId String 7721B494-1F78-4E*****E8-A7CEE7315BFA

请求ID。
AIImageJobList Array of AIImageJob

AI图片处理任务列表。
Status String success

任务状态：

  • success：成功。
  • fail：失败。
CreationTime String 2020-10-15T03:30:03Z

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

AIImageResult String [{"Score":5.035636554444242,"Url":"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif"}]

AI图片的OSS地址。

说明 为任务结果，因此该地址不提供完整的鉴权信息，需要鉴权信息需用户生成或者调用ListAIImage接口获取媒资结果。
VideoId String 357a8748c577*****789d2726e6436aa

视频ID。
JobId String cf08a2c6e11e*****de1711b738b9067

AI图片处理任务ID。
UserData String {"Extend":{"localId":"****","test":"www"}}

自定义设置。

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

参数构造详情，请参见UserData。

Code String Success

错误码。
Message String success

错误信息。
TemplateConfig String {"Format":"gif","SetDefaultCover":"true"}

提交任务时，对指定模板的配置信息的快照。
TemplateId String 5a86a00f15194*****d7fe7de1b4a173

AI模板ID。

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetAIImageJobs
&JobIds=cf08a2c6e11e*****de1711b738b9067
&公共请求参数

正常返回示例

XML格式 

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

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

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/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"
  } ]
}

错误码

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

SDK示例

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