ListAsyncTasks - 获取异步任务列表

获取异步任务列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aimiaobi:ListAsyncTaskslist
  • 全部资源
    *

请求参数

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

业务空间唯一标识: AgentKey

cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public
TaskNamestring

任务名称精确查询

任务名称
TaskCodestring

任务 Code 精确查询

MaterialDocumentUpload
TaskTypestring

任务类型精确查询

暂无
TaskStatusinteger

任务状态精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)

1
TaskStatusListarray

任务状态列表精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)

TaskStatusListinteger

任务状态

1
TaskTypeListarray

任务类型列表精确查询

TaskTypeListstring

任务分类

test
CreateTimeStartstring

任务创建时间 开始查询,格式为:YYYY-MM-DD HH:mm:ss

2023-02-19 07:28:11
CreateTimeEndstring

任务创建时间 结束查询,格式为:YYYY-MM-DD HH:mm:ss

2023-03-18 02:00:00
Currentinteger

当前页码

1
Sizeinteger

每页条数:默认 10

10

返回参数

名称类型描述示例值
object

PageResult

Codestring

状态码

successful
Currentinteger

当前页。

1
Dataarray<object>

返回的数据内容。

Dataobject

任务列表。

CreateTimestring

创建日期

2020-12-23 15:41:58
CreateUserstring

创建者

1111
Idlong

任务主键 ID

1
TaskCodestring

任务标识,标识为哪一个任务

MaterialDocumentUpload
TaskDefinitionstring

可选的任务定义配置,JSON 格式,这里的参数会覆盖系统配置的定义

{}
TaskEndTimestring

任务实际结束时间

2023-03-09 00:00:00
TaskErrorMessagestring

任务执行错误消息-供客户端查看

系统内部错误
TaskExecuteTimestring

任务执行时间,只会轮询任务到期可执行的任务、为空表示立即执行

2023-10-14 14:30:00
TaskIdstring

唯一任务 ID,作用等价于 id

3f7045e099474ba28ceca1b4eb6d6e21
TaskInnerErrorMessagestring

任务内部的执行错误消息,一些异常栈、内部线程栈等敏感信息打印在这里

系统错误
TaskIntermediateResultstring

任务中间执行结果,当一个任务可分成多步骤时,每个步骤的输出,可保存在这里。后续从暂停中恢复可以读取中间结果,从中间结果继续

{}
TaskNamestring

任务名

任务名
TaskParamstring

任务执行输入参数,JSON 格式

{}
TaskProgressMessagestring

任务执行进度信息

{}
TaskResultstring

任务执行结果信息

{}
TaskRetryCountstring

任务已经重试的次数

1
TaskStartTimestring

任务实际开始时间

2023-03-20 10:53:00
TaskStatusinteger

任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消

1
TaskTypestring

任务分类,多个任务分类一逗号分隔

test
UpdateTimestring

更新日期

2023-02-16 10:29:16
UpdateUserstring

更新者

111
HttpStatusCodeinteger

http 状态码

200
Messagestring

错误说明

successful
RequestIdstring

请求唯一标识

428DCC0D-3C63-5306-BD1B-124396AB97BE
Sizeinteger

每页记录数

10
Successboolean

是否成功:true 成功,false 失败

true
Totalinteger

总记录数

20

示例

正常返回示例

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
}

错误码

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