查询任务列表 | OceanBase 文档中心

查询任务列表

更新时间：2023-08-10 11:45:58

功能说明

查询任务列表，支持根据不同参数进行过滤。

调用说明

接口约束

调用者需要具备 TASK_VIEWER 权限。

请求路径

GET /api/v2/tasks/instances

请求参数

参数	类型	必选	示例值	描述
name	String	否	Prepare host	任务名称检索关键字，支持模糊匹配。
status	StringArray	否	RUNNING,FAILED	任务执行状态，有如下可选值： * RUNNING：执行中。 * FAILED：执行失败。 * SUCCESSFUL：执行成功。
type	String	否	MANUAL	任务类型，有如下可选值： * MANUAL：手动发起的运维任务。 * SYS_ONECE：系统执行的单次任务。 * SCHEDULED：非内置的定时执行任务。 * SYS_SCHEDULED：系统内置定时执行任务。
cluterName	String	否	meta	集群名称关键字，支持模糊匹配。
clusterId	Long	否	100	集群 ID。
tenantName	String	否	SYS	租户名称，需配合集群 ID 一起使用。
tenantId	Long	否	100	租户 ID。
hostId	Long	否	100	主机 ID。
page	Integer	否	1	分页页码，从 1 开始。
size	Integer	否	10	请求数据的分页大小。默认值：10 最大值：2000
sort	String	否	id,asc	请求数据的排序规则。

返回结果

参数	类型	说明
data	Object	请求的数据。
├─ contents	Array	BasicTaskInstance 的数组，详细数据结构见下表。
├─ page	Object	分页信息，详情参见 page 参数说明。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace ID，用于排查问题。
server	String	响应请求的应用服务的地址。

page 参数说明

参数	类型	说明
totalElements	Integer	总记录数
totalPage	Integer	总页数
number	Integer	当前页码
size	Integer	当前页大小

BasicTaskInstance 的数据结构

参数	类型	说明
id	Integer	软件包 ID
name	String	软件包名称
├─ cluster	Object	集群信息
├─ tenant	Object	租户信息
├─ creator	Object	任务创建者信息
status	Integer	任务执行状态，有如下可选值： * RUNNING：执行中 * FAILED：执行失败 * SUCCESSFUL：执行成功
startTime	String	任务开始时间
finishTime	String	任务结束时间
subtasks	ObjectArray	BasicSubtaskInstance 数组，子任务汇总信息

cluster 参数说明

参数	类型	说明
id	Long	集群在 OCP 的集群 ID
name	String	集群名称
obClusterId	Long	集群在 OceanBase 集群中的集群 ID
type	String	集群类型，有如下类型： * PRIMARY：主集群 * STANDBY：备集群

tenant 参数说明

参数	类型	说明
id	Long	租户 ID
name	String	租户名称
obClusterId	Long	租户在 OceanBase 集群中的租户 ID。
mode	String	租户模式，有如下模式： * ORACLE：Oracle 兼容模式 * MYSQL：MySQL 兼容模式

creator 参数说明

参数	类型	说明
id	Long	创建者用户 ID
name	String	创建者用户名

BasicSubtaskInstance 的数据结构

参数	类型	说明
id	Long	子任务实例 ID
name	String	子任务名称
description	String	子任务描述信息
status	String	子任务状态，有如下几种状态： * PENDING：初始态，等待上游节点执行完成 * READY：准备中，依赖节点已经执行完成，等待执行 * RUNNING：执行中 * CANCELING：取消中 * FAILED：终态，执行失败 * SUCCESSFUL：终态：执行成功
operation	String	子任务操作，有如下几种操作： * EXECUTE：正常执行 * RETRY：重试 * ROLLBACK：回滚 * SKIP：跳过 * CANCEL：取消

示例

请求示例

GET /api/v2/tasks/instances

返回示例

{
  "data": {
    "contents": [
      {
        "cluster": {
          "id": 1,
          "name": "ob20daily.xiaojun.chengxj",
          "obClusterId": 1,
          "type": "PRIMARY"
        },
        "creator": {
          "id": 200,
          "name": "system"
        },
        "finishTime": "2021-08-12T13:40:09.573+08:00",
        "id": 6202983,
        "name": "Prepare tenant",
        "startTime": "2021-08-06T17:37:58.01+08:00",
        "status": "SUCCESSFUL",
        "subtasks": [
          {
            "description": "Set whitelist",
            "id": 9009988,
            "name": "Set whitelist",
            "operation": "EXECUTE",
            "status": "PENDING"
          },
          {
            "description": "Update tenant status",
            "id": 9009989,
            "name": "Update tenant status",
            "operation": "EXECUTE",
            "status": "PENDING"
          },
          {
            "description": "Set super user password",
            "id": 9009987,
            "name": "Set super user password",
            "operation": "ROLLBACK",
            "status": "PENDING"
          }
        ],
        "tenant": {
          "id": 169,
          "mode": "ORACLE",
          "name": "zhiqiong",
          "obTenantId": 1584
        }
      },
      {
        "cluster": {
          "id": 1,
          "name": "ob20daily.xiaojun.chengxj",
          "obClusterId": 1,
          "type": "PRIMARY"
        },
        "creator": {
          "id": 100,
          "name": "admin"
        },
        "finishTime": "2021-08-04T19:19:05.158+08:00",
        "id": 6175879,
        "name": "Generate workload report",
        "startTime": "2021-08-04T19:14:08.512+08:00",
        "status": "SUCCESSFUL",
        "subtasks": [
          {
            "description": "Wait node",
            "id": 8976786,
            "name": "Wait node",
            "operation": "EXECUTE",
            "status": "SUCCESSFUL"
          },
          {
            "description": "Store workload report",
            "id": 8976793,
            "name": "Store workload report",
            "operation": "EXECUTE",
            "status": "SUCCESSFUL"
          },
          {
            "description": "Generate report",
            "id": 8976785,
            "name": "Generate report",
            "operation": "EXECUTE",
            "status": "SUCCESSFUL"
          },
          {
            "description": "Generate report",
            "id": 8976783,
            "name": "Generate report",
            "operation": "EXECUTE",
            "status": "SUCCESSFUL"
          },
          {
            "description": "Generate report",
            "id": 8976790,
            "name": "Generate report",
            "operation": "EXECUTE",
            "status": "SUCCESSFUL"
          },
          {
            "description": "Generate report",
            "id": 8976789,
            "name": "Generate report",
            "operation": "EXECUTE",
            "status": "SUCCESSFUL"
          }
        ]
      }
    ],
    "page": {
      "number": 1,
      "size": 10,
      "totalElements": 2,
      "totalPages": 1
    }
  },
  "duration": 95,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-08-25T14:30:27.27+08:00",
  "traceId": "2592dcf6c88f41bf"
}