获取异步任务列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
aimiaobi:ListAsyncTasks | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AgentKey | string | 是 | 业务空间唯一标识: AgentKey | cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public |
TaskName | string | 否 | 任务名称精确查询 | 任务名称 |
TaskCode | string | 否 | 任务 Code 精确查询 | MaterialDocumentUpload |
TaskType | string | 否 | 任务类型精确查询 | 暂无 |
TaskStatus | integer | 否 | 任务状态精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消) | 1 |
TaskStatusList | array | 否 | 任务状态列表精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消) | |
TaskStatusList | integer | 否 | 任务状态 | 1 |
TaskTypeList | array | 否 | 任务类型列表精确查询 | |
TaskTypeList | string | 否 | 任务分类 | test |
CreateTimeStart | string | 否 | 任务创建时间 开始查询,格式为:YYYY-MM-DD HH:mm:ss | 2023-02-19 07:28:11 |
CreateTimeEnd | string | 否 | 任务创建时间 结束查询,格式为:YYYY-MM-DD HH:mm:ss | 2023-03-18 02:00:00 |
Current | integer | 否 | 当前页码 | 1 |
Size | integer | 否 | 每页条数:默认 10 | 10 |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "successful",
"Current": 1,
"Data": [
{
"CreateTime": "2020-12-23 15:41:58",
"CreateUser": "1111",
"Id": 1,
"TaskCode": "MaterialDocumentUpload",
"TaskDefinition": "{}",
"TaskEndTime": "2023-03-09 00:00:00",
"TaskErrorMessage": "系统内部错误",
"TaskExecuteTime": "2023-10-14 14:30:00",
"TaskId": "3f7045e099474ba28ceca1b4eb6d6e21",
"TaskInnerErrorMessage": "系统错误",
"TaskIntermediateResult": "{}",
"TaskName": "任务名",
"TaskParam": "{}",
"TaskProgressMessage": "{}",
"TaskResult": "{}",
"TaskRetryCount": "1",
"TaskStartTime": "2023-03-20 10:53:00",
"TaskStatus": 1,
"TaskType": "test",
"UpdateTime": "2023-02-16 10:29:16",
"UpdateUser": "111"
}
],
"HttpStatusCode": 200,
"Message": "successful",
"RequestId": "428DCC0D-3C63-5306-BD1B-124396AB97BE",
"Size": 10,
"Success": true,
"Total": 20
}
错误码
访问错误中心查看更多错误码。