文档首页/ 分布式消息服务Kafka版/ API参考（联盟区域）/ API V2（推荐）/ 后台任务管理/ 查询实例的后台任务列表
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例的后台任务列表

功能介绍

查询实例的后台任务列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

开启查询的任务编号。

limit

否

Integer

查询的任务个数。

begin_time

否

String

查询任务的最小时间，格式为YYYYMMDDHHmmss。

end_time

否

String

查询任务的最大时间，格式为YYYYMMDDHHmmss。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

task_count

String

参数解释：

任务数量。

取值范围：

不涉及。

tasks

Array of tasks objects

参数解释：

任务列表。
表4 tasks

参数

参数类型

描述

id

String

参数解释：

任务ID。

取值范围：

不涉及。

name

String

参数解释：

任务名称。

取值范围：

不涉及。

user_name

String

参数解释：

用户名。

取值范围：

不涉及。

user_id

String

参数解释：

用户ID。

取值范围：

不涉及。

params

String

参数解释：

任务参数。

取值范围：

不涉及。

status

String

参数解释：

任务状态。

取值范围：

  • CREATED：后台任务状态为创建成功。

  • SUCCESS：后台任务状态为成功。

  • FAILED：后台任务状态为失败。

  • DELETED：后台任务状态为已删除。

  • EXECUTING：后台任务状态为执行中。

  • CANCELLED：定时任务状态为取消。

created_at

String

参数解释：

启动时间。

取值范围：

不涉及。

updated_at

String

参数解释：

结束时间。

取值范围：

不涉及。

请求示例

'GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks?start={start}&limit={limit}&begin_time={begin_time}&end_time={end_time}'

响应示例

状态码：200

查询实例的后台任务列表

{
  "task_count" : "4",
  "tasks" : [ {
    "id" : "8abfa7b372160bfd0172165864064079",
    "name" : "modifyAutoTopic",
    "user_name" : "paas_dms",
    "user_id" : "3df5acbc24a54fadb62a043c9000a307",
    "params" : "{\"old_auto_status\":true,\"new_auto_status\":false}",
    "status" : "EXECUTING",
    "created_at" : "2020-05-15T03:19:51.046Z",
    "updated_at" : "2020-05-15T03:19:51.065Z"
  }, {
    "id" : "8abfa7b372160bfd017216560af83e6e",
    "name" : "changeRetentionPolicy",
    "user_name" : "paas_dms",
    "user_id" : "3df5acbc24a54fadb62a043c9000a307",
    "params" : "{\"new_retention_policy\":\"produce_reject\",\"origin_retention_policy\":\"time_base\"}",
    "status" : "SUCCESS",
    "created_at" : "2020-05-15T03:17:17.176Z",
    "updated_at" : "2020-05-15T03:17:22.162Z"
  } ]
}

状态码

状态码

描述

200

查询实例的后台任务列表

错误码

请参见错误码。

父主题： 后台任务管理