该接口提供通过多种条件查询任务列表的功能。通过该接口可以查询指定时间范围内的任务、或者通过创建任务时指定的Tag搜索任务等。
接口说明
请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| imm:ListTasks | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 项目名称，获取方式请参见创建项目。 | test-project |
| TaskTypes | array | 否 | 查询的任务类型列表。 | |
| string | 否 | 任务类型。取值范围请参见任务类型列表。 | ["OfficeConversion","VideoLabelClassification"] | |
| NextToken | string | 否 | 翻页标记。 当文件总数大于设置的 MaxResults 时，用于翻页的 Token。从 NextToken 开始按字典序返回文件信息列表。 说明
在一次查询中首次调用此接口时，将此值设置为空。
| MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw== |
| MaxResults | long | 否 | 返回结果列表中最大任务数量。取值范围为（0，100 ]，默认值为 100。 | 1 |
| TagSelector | string | 否 | 自定义任务标签。在创建任务时如果指定了“Tag”参数，可以通过此参数进行搜索。 | test=val1 |
| Sort | string | 否 | 返回的任务信息列表排序规则。取值范围如下：
| TaskId |
| Order | string | 否 | 排序方式。取值范围如下：
| ASC |
| Status | string | 否 | 任务运行状态。取值范围如下：
| Succeeded |
| StartTimeRange | TimeRange | 否 | 任务开始的时间范围。可筛选某段时间内开始执行的任务。 | |
| EndTimeRange | TimeRange | 否 | 任务结束的时间范围。可筛选某段时间内结束执行的任务。 | |
| RequestDefinition | boolean | 否 | 是否需要返回创建任务的初始请求参数，默认值为 False。 | True |
返回参数
示例
正常返回示例
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-11 | OpenAPI 入参发生变更 | 查看变更详情 |