获取任务列表,根据用户所给参数,返回所有符合条件的任务列表。

调试

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

请求参数

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

系统规定参数。取值:ListSmartJobs

Status Long Finished

任务状态

  • Created
  • Executing
  • Finished
  • Failed
NextToken String ****73f33c91-d59383e8280b****

当前开始读取的位置

MaxResults Long 10

本次请求所返回的最大记录条数。

最大值:100,默认值:10

PageNo Long 1

当前页码。默认值为1。

PageSize Long 10

分页大小,每页显示条数。默认值为10,最大值为100。

JobType String ASR

任务类型

SortBy String CreationTime:Desc

排序参数,默认根据创建时间倒序

JobState String Finished

任务状态

返回数据

名称 类型 示例值 描述
RequestId String ****9262E3DA-07FA-4862-FCBB6BC61D08*****

请求ID。

SmartJobList Array of SmartJobList

智能任务列表

JobId String ****20b48fb04483915d4f2cd8ac****

任务Id

Title String 测试标题

任务标题

Description String 测试描述

任务描述

UserId Long 1084506228******

用户Id

JobType String ASR

任务类型

EditingConfig String {"AudioConfig":{},"InputConfig":""}

输入配置

UserData String {"user":"data"}

用户自定义字段

JobState String Finished

任务状态

CreateTime String 2020-12-26T04:11:10Z

创建时间

ModifiedTime String 2020-12-26T04:11:10Z

最后修改时间

InputConfig Object

任务输入配置

InputFile String oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4

文件信息

Keyword String 测试关键词

关键词信息

OutputConfig Object

任务输出配置

Bucket String test-bucket

OSS Bucket

Object String test-object

OSS Object

NextToken String CBB6BC61D08

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕。

MaxResults String 10

本次请求所返回的最大记录条数,最后一页前每页记录条数为MaxResults取值。 例如: 正例:10,10,5,反例:10,5,10

TotalCount String 110

本次请求条件下的数据总量,此参数为可选参数,默认可不返回。

示例

请求示例

http(s)://[Endpoint]/?Action=ListSmartJobs
&NextToken=****73f33c91-d59383e8280b****
&MaxResults=10
&PageNo=1
&PageSize=10
&JobType=ASR
&SortBy=CreationTime:Desc
&JobState=Finished
&公共请求参数

正常返回示例

XML格式

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

<ListSmartJobsResponse>
    <RequestId>****9262E3DA-07FA-4862-FCBB6BC61D08*****</RequestId>
    <SmartJobList>
        <JobId>****20b48fb04483915d4f2cd8ac****</JobId>
        <Title>测试标题</Title>
        <Description>测试描述</Description>
        <JobType>ASR</JobType>
        <EditingConfig>{"AudioConfig":{},"InputConfig":""}</EditingConfig>
        <UserData>{"user":"data"}</UserData>
        <JobState>Finished</JobState>
        <CreateTime>2020-12-26T04:11:10Z</CreateTime>
        <ModifiedTime>2020-12-26T04:11:10Z</ModifiedTime>
        <InputConfig>
            <InputFile>oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4</InputFile>
            <Keyword>测试关键词</Keyword>
        </InputConfig>
        <OutputConfig>
            <Bucket>test-bucket</Bucket>
            <Object>test-object</Object>
        </OutputConfig>
    </SmartJobList>
    <NextToken>CBB6BC61D08</NextToken>
    <MaxResults>10</MaxResults>
    <TotalCount>110</TotalCount>
</ListSmartJobsResponse>

JSON格式

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

{
  "RequestId" : "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "SmartJobList" : [ {
    "JobId" : "****20b48fb04483915d4f2cd8ac****",
    "Title" : "测试标题",
    "Description" : "测试描述",
    "JobType" : "ASR",
    "EditingConfig" : "{\"AudioConfig\":{},\"InputConfig\":\"\"}",
    "UserData" : "{\"user\":\"data\"}",
    "JobState" : "Finished",
    "CreateTime" : "2020-12-26T04:11:10Z",
    "ModifiedTime" : "2020-12-26T04:11:10Z",
    "InputConfig" : {
      "InputFile" : "oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
      "Keyword" : "测试关键词"
    },
    "OutputConfig" : {
      "Bucket" : "test-bucket",
      "Object" : "test-object"
    }
  } ],
  "NextToken" : "CBB6BC61D08",
  "MaxResults" : "10",
  "TotalCount" : "110"
}

错误码

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

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