文档

ListTasks - 查询任务列表

更新时间:

该接口提供通过多种条件查询任务列表的功能。通过该接口可以查询指定时间范围内的任务、或者通过创建任务时指定的Tag搜索任务等。

接口说明

请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格

调试

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

授权信息

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

请求参数

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

项目名称,获取方式请参见创建项目

test-project
TaskTypesarray

查询的任务类型列表。

string

任务类型。取值范围请参见任务类型列表

["OfficeConversion","VideoLabelClassification"]
NextTokenstring

翻页标记。

当文件总数大于设置的 MaxResults 时,用于翻页的 Token。从 NextToken 开始按字典序返回文件信息列表。

说明 在一次查询中首次调用此接口时,将此值设置为空。
MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
MaxResultslong

返回结果列表中最大任务数量。取值范围为(0,100 ],默认值为 100。

1
TagSelectorstring

自定义任务标签。在创建任务时如果指定了“Tag”参数,可以通过此参数进行搜索。

test=val1
Sortstring

返回的任务信息列表排序规则。取值范围如下:

  • TaskId(默认):任务 ID。

  • StartTime:任务开始时间。

  • EndTime:任务结束时间。

TaskId
Orderstring

排序方式。取值范围如下:

  • ASC(默认):升序

  • DES:降序

ASC
Statusstring

任务运行状态。取值范围如下:

  • Running:任务运行中。

  • Succeeded:任务执行完成,成功。

  • Failed:任务执行完成,失败。

Succeeded
StartTimeRangeTimeRange

任务开始的时间范围。可筛选某段时间内开始执行的任务。

EndTimeRangeTimeRange

任务结束的时间范围。可筛选某段时间内结束执行的任务。

RequestDefinitionboolean

是否需要返回创建任务的初始请求参数,默认值为 False。

True

返回参数

名称类型描述示例值
object

符合条件的任务列表。

RequestIdstring

请求 ID。

9847E7D0-A9A3-0053-84C6-BA16FFFA726E
ProjectNamestring

项目名称。

immtest
NextTokenstring

翻页标记。当任务列表总数大于设置的 MaxResults 时,用于翻页的 Token。符合条件的任务列表未全部返回时,此参数才有值。

下一次列出任务列表时将此值作为 NextToken 传入,将后续的任务列表返回。

MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
MaxResultsstring

本次返回的任务列表长度。

1
Tasksarray

任务信息列表。

TaskInfo

任务的详细信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "9847E7D0-A9A3-0053-84C6-BA16FFFA726E",
  "ProjectName": "immtest",
  "NextToken": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==",
  "MaxResults": "1",
  "Tasks": [
    {
      "Status": "Running",
      "Code": "ResourceNotFound",
      "Message": "The specified resource project is not found.",
      "StartTime": "2021-12-24T03:01:41.662060377Z",
      "EndTime": "2021-12-24T03:01:49.480109219Z",
      "UserData": "{\"ID\": \"user1\",\"Name\": \"test-user1\",\"Avatar\": \"http://example.com?id=user1\"}",
      "TaskType": "VideoLabelClassification",
      "TaskId": "c2b277b9-0d30-4882-ad6d-ad661382****",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "TaskRequestDefinition": "",
      "Progress": 0
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-11OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:RequestDefinition
  • 本页导读 (1)