文档

ListSmartJobs - 获取任务列表

更新时间:

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

调试

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

授权信息

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

请求参数

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

当前开始读取的位置

****73f33c91-d59383e8280b****
MaxResultslong

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

最大值:100,默认值:10

10
PageNolong

当前页码。默认值为 1。

1
PageSizelong

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

10
JobTypestring

任务类型

枚举值:
  • ASRASR任务
  • DynamicChart动态图表任务
  • TextToSpeech智能语音任务
ASR
SortBystring

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

枚举值:
  • CreationTime:Asc按照创建时间正序
  • CreationTime:Desc按照创建时间倒序
CreationTime:Desc
JobStatestring

任务状态

枚举值:
  • Finished执行完成
  • Failed执行失败
  • Executing任务执行中
  • Created任务已创建
Finished

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

****9262E3DA-07FA-4862-FCBB6BC61D08*****
SmartJobListobject []

智能任务列表

JobIdstring

任务 Id

****20b48fb04483915d4f2cd8ac****
Titlestring

任务标题

测试标题
Descriptionstring

任务描述

测试描述
UserIdlong

用户 Id

1084506228******
JobTypestring

任务类型

枚举值:
  • ASRASR任务
  • DynamicChart动态图表任务
  • TextToSpeech智能语音任务
ASR
EditingConfigstring

输入配置

{"AudioConfig":{},"InputConfig":""}
UserDatastring

用户自定义字段

{"user":"data"}
JobStatestring

任务状态

枚举值:
  • Finished执行完成
  • Failed执行失败
  • Executing任务执行中
  • Created任务已创建
Finished
CreateTimestring

创建时间

2020-12-26T04:11:10Z
ModifiedTimestring

最后修改时间

2020-12-26T04:11:10Z
InputConfigobject

任务输入配置

InputFilestring

文件信息

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

关键词信息

测试关键词
OutputConfigobject

任务输出配置

Bucketstring

OSS Bucket

test-bucket
Objectstring

OSS Object

test-object
NextTokenstring

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

CBB6BC61D08
MaxResultsstring

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

10
TotalCountstring

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

110

示例

正常返回示例

JSON格式

{
  "RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "SmartJobList": [
    {
      "JobId": "****20b48fb04483915d4f2cd8ac****",
      "Title": "测试标题",
      "Description": "测试描述",
      "UserId": 0,
      "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"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-02-21OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:Status
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)