文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat类API/ 异步任务管理/ 获取异步任务 - ListAsyncTasks
更新时间：2026-03-24 GMT+08:00
查看PDF
分享

获取异步任务 - ListAsyncTasks

功能介绍

获取异步任务

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/instances/{instance_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号。获取方法，请参见获取项目ID。

instance_id

是

String

LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。
表2 Query参数

参数

是否必选

参数类型

描述

task_type

是

String

任务类型：CONNECTION-连接，DATABASE-数据库，TABLE-表

task_id

否

String

异步任务ID。创建异步任务时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

task_name

否

String

异步任务名称

metadata_name

否

String

元数据名称

limit

否

Integer

查询返回条数。

marker

否

String

查询的起始记录ID。

reverse_page

否

Boolean

是否倒序查询。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

Array of strings

租户token。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

page_info

PagedInfo object

分页信息。

async_tasks

Array of AsyncTask objects

异步任务列表
表5 PagedInfo

参数

参数类型

描述

current_count

Integer

本次返回的对象个数。最小值为0，最大值为2000。

next_marker

String

下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。

previous_marker

String

上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。
表6 AsyncTask

参数

参数类型

描述

task_id

String

异步任务ID

task_name

String

任务名称。

task_status

String

异步任务状态：RUNNING任务运行中，ERROR任务运行错误，COMPLETED任务运行完成，RECOVER任务异常恢复。

create_time

String

创建时间。

update_time

String

最后一次修改时间。

message

String

任务运行信息。

metadata_name

String

元数据名称

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error

Error object

错误信息。

error_code

String

错误码。

error_msg

String

错误描述。

title

String

标题。
表10 Error

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

title

String

标题。

message

String

错误信息。

code

String

状态码。

状态码：404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：408

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

请求示例

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/tasks

响应示例

状态码：200

OK

{
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "006f492b-xxxx",
    "previous_marker" : "003e6eba-xxxx"
  },
  "async_tasks" : [ {
    "task_status" : "RUNNING",
    "create_time" : "2023-05-30T09:06:41.372+00:00",
    "update_time" : "2023-05-30T09:06:41.372+00:00",
    "message" : ""
  }, {
    "task_status" : "ERROR",
    "create_time" : "2023-05-30T09:06:41.372+00:00",
    "update_time" : "2023-05-30T09:06:41.372+00:00",
    "message" : "internal error"
  }, {
    "task_status" : "COMPLETED",
    "create_time" : "2023-05-30T09:06:41.372+00:00",
    "update_time" : "2023-05-30T09:06:41.372+00:00",
    "message" : ""
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码。

父主题： 异步任务管理

相关文档