GetAIImageJobs - 查询AI图片任务列表

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

接口说明

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

QPS限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

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

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求ID。

7721B494-1F78-4E*****E8-A7CEE7315BFA
AIImageJobListarray

AI图片处理任务列表。

object

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

示例

请求示例

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

正常返回示例

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"
        }
    ]
}

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>

错误码

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

阿里云首页 视频点播 相关技术圈