首批通过分布式安全可靠测评，为关键业务系统打造
获取任务的详细信息
更新时间：2026-04-10 11:58:35
编辑
分享
本文档介绍如何获取一个任务（DAG）的详细信息。
调用说明
接口约束
obshell Server 会对该 API 进行安全校验，详细介绍可参见 API 混合加密。
请求路径
GET /api/v1/task/dag/{id}
此处的 id 需配置为 DAG 的通用 ID。
请求参数
| 参数 | 类型 | 必选 | 示例值 | 描述 |
|---|---|---|---|---|
| show_details | bool | 否 | true | 控制是否需要展示 DAG 的详细信息，默认为 true，即需要展示。 |
返回结果
| 参数 | 类型 | 说明 |
|---|---|---|
| successful | bool | 请求是否成功。 |
| timestamp | time.Time | 服务端完成请求的时间戳。 |
| duration | int | 服务端处理请求的时间（毫秒）。 |
| status | int | 符合 HTTP Status 规范的编码。 |
| traceId | string | 请求的 Trace ID。 |
| data | DagDetailDTO | 详情参见下文 DagDetailDTO 信息的数据结构。 |
| error | ApiError | 请求产生的 Error，包含如下信息：
|
DagDetailDTO 信息的数据结构如下：
| 参数 | 类型 | 说明 |
|---|---|---|
| id | string | DAG 通用 ID。 |
| dag_id | int | DAG id，是记录在 OceanBase 数据库中的主键。 |
| name | string | DAG 名称。 |
| stage | int | DAG 的当前执行阶段。 |
| max_stage | int | DAG 执行过程中的总阶段数。 |
| state | string | DAG 执行状态。 |
| operator | string | DAG 执行操作类型。 |
| start_time | time.Time | DAG 执行起始时间。 |
| end_time | time.Time | DAG 执行结束时间。 |
| additional_data | map[string]any | DAG 其他数据。 |
| nodes | []NodeDetailDTO | DAG 内的所有 Node 信息，详见 获取 Node 的详细信息。 |
示例
请求示例
GET 10.10.10.1:2886/api/v1/task/dag/11
返回示例
示例中返回了一个名为 Cluster scale out（扩容）任务的详细内容，执行操作为 RUN，执行结果为 SUCCEED。
{
"successful": true,
"timestamp": "2024-01-09T20:41:08.381582598+08:00",
"duration": 74,
"status": 200,
"traceId": "d085c58bceafa7f9",
"data": {
"id": "11",
"dag_id": 1,
"name": "Cluster scale out",
"stage": 9,
"max_stage": 9,
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:01.706073+08:00",
"end_time": "2024-01-09T20:40:30.319822+08:00",
"additional_data": {},
"nodes": [
{
"id": "11",
"node_id": 1,
"name": "Integrate server config",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:01.718882+08:00",
"end_time": "2024-01-09T20:40:02.751743+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "11",
"task_id": 1,
"name": "Integrate server config",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:01.74723+08:00",
"end_time": "2024-01-09T20:40:01.76717+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": []
}
]
},
{
"id": "12",
"node_id": 2,
"name": "Create local scale out dag",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:03.77982+08:00",
"end_time": "2024-01-09T20:40:04.805204+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "12",
"task_id": 2,
"name": "Create local scale out dag",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:03.796683+08:00",
"end_time": "2024-01-09T20:40:03.836712+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"create local scale out dag success, genericID:22130706433028869"
]
}
]
},
{
"id": "13",
"node_id": 3,
"name": "Wait scale out ready",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:05.828194+08:00",
"end_time": "2024-01-09T20:40:06.85324+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "13",
"task_id": 3,
"name": "Wait scale out ready",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:05.845011+08:00",
"end_time": "2024-01-09T20:40:05.861857+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"local scale out dag task Be scaling agent is succeed"
]
}
]
},
{
"id": "14",
"node_id": 4,
"name": "Wait remote deploy finish",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:07.876596+08:00",
"end_time": "2024-01-09T20:40:13.968817+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "14",
"task_id": 4,
"name": "Wait remote deploy finish",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:07.894515+08:00",
"end_time": "2024-01-09T20:40:13.950807+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"retry stage: 2 successfully",
"remote deploy task is succeed"
]
}
]
},
{
"id": "15",
"node_id": 5,
"name": "Wait remote start finish",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:14.996088+08:00",
"end_time": "2024-01-09T20:40:21.091862+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "15",
"task_id": 5,
"name": "Wait remote start finish",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:15.016+08:00",
"end_time": "2024-01-09T20:40:21.079217+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"retry stage: 4 successfully",
"remote start observer task is succeed"
]
}
]
},
{
"id": "16",
"node_id": 6,
"name": "Prev check for scale_out",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:22.115167+08:00",
"end_time": "2024-01-09T20:40:23.142216+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "16",
"task_id": 6,
"name": "Prev check for scale_out",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:22.134063+08:00",
"end_time": "2024-01-09T20:40:22.148848+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"PrevCheckTask execute"
]
}
]
},
{
"id": "17",
"node_id": 7,
"name": "Add server for scale_out",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:24.167045+08:00",
"end_time": "2024-01-09T20:40:25.194054+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "17",
"task_id": 7,
"name": "Add server for scale_out",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:24.186025+08:00",
"end_time": "2024-01-09T20:40:24.21232+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"AddServerTask execute"
]
}
]
},
{
"id": "18",
"node_id": 8,
"name": "Add agent for scale_out",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:26.219246+08:00",
"end_time": "2024-01-09T20:40:27.247243+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "18",
"task_id": 8,
"name": "Add agent for scale_out",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:26.238089+08:00",
"end_time": "2024-01-09T20:40:26.252762+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": []
}
]
},
{
"id": "19",
"node_id": 9,
"name": "Check cluster scale_out whether finished",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:28.275457+08:00",
"end_time": "2024-01-09T20:40:30.315618+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "19",
"task_id": 9,
"name": "Check cluster scale_out whether finished",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:28.293296+08:00",
"end_time": "2024-01-09T20:40:30.308244+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": [
"FinishTask execute"
]
}
]
}
]
}
}
相关文档
除通过命令行调用 API 接口外，还可以通过 SDK 方法调用 API。
