调用ListTasks接口获取单个或多个任务（人脸聚类、视频标签检测、图片识别、视频识别、视频转码和文档转换）的详细信息，包括任务类型，任务运行状态、任务开始时间等。

调试

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

请求参数

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

操作接口名称，固定取值为ListTasks。
ProjectName String 是 immtest

项目名称。
TaskTypes Array of String 否 ["OfficeConversion","VideoLabelClassification"]

任务类型列表。取值范围请参见TaskType（任务类型）列表。
NextToken String 否 MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==

翻页标记。

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

第一次调用此接口时，设置为空。
MaxResults Long 否 1

最大结果数量。
TagSelector String 否 test=val1

自定义任务标签。
Sort String 否 TaskId

按照指定字段排序。取值范围如下：

  • TaskId（默认）：任务ID。
  • StartTime：任务开始时间。
  • EndTime：任务结束时间。
Order String 否 ASC

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

  • ASC（默认）：升序
  • DES：降序
Status String 否 Succeeded

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

  • Running：任务运行中。
  • Succeeded：任务执行完成，成功。
  • Failed：任务执行完成，失败。
StartTimeRange TimeRange 否

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

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

返回数据

名称 类型 示例值 描述
RequestId String 9847E7D0-A9A3-0053-84C6-BA16FFFA726E

请求ID。
ProjectName String immtest

项目名称。
NextToken String MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==

翻页标记。当文件未全部返回时，此参数才有值。

当文件总数大于设置的MaxResults时，用于翻页的Token。

下一次列出文件信息时以此值为NextToken，将未返回的结果返回。
MaxResults String 1

实际结果数量。
Tasks Array of TaskInfo

任务信息。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTasks
&ProjectName=immtest
&TaskTypes=["OfficeConversion","VideoLabelClassification"]
&NextToken=MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
&MaxResults=1
&TagSelector=test=val1
&Sort=TaskId
&Order=ASC
&Status=Succeeded
&StartTimeRange={}
&EndTimeRange={}
&公共请求参数

正常返回示例

JSON格式

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

{
  "Tasks" : [ {
    "Status" : "Succeeded",
    "TaskId" : "VideoLabelClassification-cd635e56-935a-4440-8402-e742e8e11217",
    "EndTime" : "2022-05-19T03:13:39.707Z",
    "UserData" : "{\"ID\": \"user1\",\"Name\": \"test-user1\",\"Avatar\": \"http://xxx.cn/?id=user1\"}",
    "TaskType" : "VideoLabelClassification",
    "StartTime" : "2022-05-19T03:13:36.944Z",
    "Tags" : {
      "test" : "val1"
    }
  } ],
  "RequestId" : "9847E7D0-A9A3-0053-84C6-BA16FFFA726E",
  "NextToken" : "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==",
  "ProjectName" : "immtest",
  "MaxResults" : "1"
}