ListSmartJobs - 获取任务列表

更新时间:
复制为 MD 格式

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListSmartJobs

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

NextToken

string

当前开始读取的位置

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

MaxResults

integer

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

最大值:100,默认值:10

10

PageNo

integer

当前页码。默认值为 1。

1

PageSize

integer

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

10

JobType

string

任务类型

枚举值:

  • ASR :

    ASR 任务

  • DynamicChart :

    动态图表任务

  • VideoTranslation :

    视频翻译任务

  • TextToSpeech :

    智能语音任务

ASR

SortBy

string

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

枚举值:

  • CreationTime:Asc :

    按照创建时间正序

  • CreationTime:Desc :

    按照创建时间倒序

CreationTime:Desc

JobState

string

任务状态

枚举值:

  • Finished :

    执行完成

  • Failed :

    执行失败

  • Executing :

    任务执行中

  • Created :

    任务已创建

Finished

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

****9262E3DA-07FA-4862-FCBB6BC61D08*****

SmartJobList

array<object>

智能任务列表

array<object>

智能任务

JobId

string

任务 Id

****20b48fb04483915d4f2cd8ac****

Title

string

任务标题

Test title

Description

string

任务描述

Test description

UserId

integer

用户 Id

1084506228******

JobType

string

任务类型

枚举值:

  • ASR :

    ASR 任务

  • DynamicChart :

    动态图表任务

  • TextToSpeech :

    智能语音任务

ASR

EditingConfig

string

输入配置

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

UserData

string

用户自定义字段

{"user":"data"}

JobState

string

任务状态

枚举值:

  • Finished :

    执行完成

  • Failed :

    执行失败

  • Executing :

    任务执行中

  • Created :

    任务已创建

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

关键词信息

Test keyword

OutputConfig

object

任务输出配置

Bucket

string

OSS Bucket

test-bucket

Object

string

OSS Object

test-object

NextToken

string

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

CBB6BC61D08

MaxResults

string

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

10

TotalCount

string

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

110

示例

正常返回示例

JSON格式

{
  "RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "SmartJobList": [
    {
      "JobId": "****20b48fb04483915d4f2cd8ac****",
      "Title": "Test title",
      "Description": "Test 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": "Test keyword"
      },
      "OutputConfig": {
        "Bucket": "test-bucket",
        "Object": "test-object"
      }
    }
  ],
  "NextToken": "CBB6BC61D08",
  "MaxResults": "10",
  "TotalCount": "110"
}

错误码

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

变更历史

更多信息,参考变更详情