# 查询工作流详情

读取一个工作流的定义、运行配置和状态。更新、暂停或删除前应先读取详情。

```text
GET https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/{workflow_id}
```

## 调用前准备

先[查询工作流列表](list-workflows.md)取得工作流 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$WORKFLOW_ID`：要查询的工作流 ID。

## 路径参数

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `workflow_id` | string | 工作流 ID。 |

## 请求示例

```bash
curl "https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/$WORKFLOW_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"
```

## 成功响应

成功时返回 `200`。`data.workflow` 包含当前定义、运行表单、触发器和执行摘要。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workflow": {
      "id": "wf-001",
      "name": "daily-import",
      "description": "导入每日文件",
      "source_type": "manual_dsl",
      "status": "ready",
      "available_actions": ["update", "delete", "run", "pause", "list_executions"],
      "execution_mode": "cron",
      "dsl_yaml": "workflow: {}",
      "runtime_fields": {"fields": []},
      "default_values": {},
      "execution_summary": {
        "total_executions": 8,
        "active_executions": 0
      },
      "trigger_summary": {
        "mode": "cron",
        "configured": true,
        "enabled": true
      },
      "latest_workflow_version_id": "ver-001",
      "compute_resource_id": "compute-001"
    }
  }
}
```

响应字段如下。

本文中，字段路径中的 `[]` 表示数组中的每一项。例如，`items[].name` 表示 `items` 数组中每一项的 `name` 字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.workflow.id` | string | 工作流标识。 |
| `data.workflow.name` | string | 工作流名称。 |
| `data.workflow.description` | string | 工作流说明；未设置时可能省略。 |
| `data.workflow.source_type` | string | 来源类型。 |
| `data.workflow.status` | string | 当前状态。 |
| `data.workflow.execution_mode` | string | 执行模式。 |
| `data.workflow.available_actions` | string（字符串数组） | 当前允许的操作；不是未来请求仍可执行的保证。 |
| `data.workflow.dsl_yaml` | string | 工作流 DSL YAML。 |
| `data.workflow.runtime_fields` | object | 运行时输入表单；未配置时可能省略。 |
| `data.workflow.default_values` | object | 运行表单的默认值；未配置时可能省略。 |
| `data.workflow.execution_summary` | object | 执行数量与活动执行信息。 |
| `data.workflow.trigger_summary` | object | 触发器模式及其配置、启用状态。 |
| `data.workflow.cron_expression` | string | Cron 表达式；仅定时模式返回。 |
| `data.workflow.goal` | string | 工作流目标；服务端提供时返回。 |
| `data.workflow.planner_model` | string | 规划模型；服务端提供时返回。 |
| `data.workflow.draft_id` | string | 草稿标识；服务端提供时返回。 |
| `data.workflow.candidate_id` | string | 候选标识；服务端提供时返回。 |
| `data.workflow.run_context` | object | 工作流运行上下文；服务端提供时返回。 |
| `data.workflow.runtime_layout` | object | 运行时表单布局；未配置时可能省略。 |
| `data.workflow.moi_workflow_def_id` | string | 工作流定义标识；服务端提供时返回。 |
| `data.workflow.latest_workflow_version_id` | string | 当前最新工作流版本 ID。 |
| `data.workflow.latest_version` | integer | 最新工作流版本序号；服务端提供时返回。 |
| `data.workflow.latest_version_status` | string | 最新工作流版本状态；服务端提供时返回。 |
| `data.workflow.compute_resource_id` | string | 关联的计算资源 ID；未关联时可能省略。 |
| `data.workflow.compute_resource_bindings` | object（对象数组） | 工作流或节点的计算资源绑定；未配置时可能省略。 |
| `data.workflow.compute_resource_bindings[].id` | string | 计算资源 ID。 |
| `data.workflow.compute_resource_bindings[].name` | string | 计算资源名称。 |
| `data.workflow.compute_resource_bindings[].workflow_level` | boolean | 是否为工作流级绑定。 |
| `data.workflow.compute_resource_bindings[].node_names` | string（字符串数组） | 使用该绑定的节点名称。 |
| `data.workflow.created_at` | string | 创建时间；服务端提供时返回。 |
| `data.workflow.updated_at` | string | 最后更新时间；服务端提供时返回。 |

## 错误响应

```json
{
  "code": "ErrNotFound",
  "msg": "资源不存在",
  "data": null
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 工作流 ID 无效。
  - 使用列表或发布响应中的 `id`。
* - `401`
  - `ErrUnauthorized`
  - 缺少或无效的访问凭据。
  - 检查 API Key 和工作区 Header。
* - `403`
  - `ErrForbidden`
  - 当前身份没有读取该工作流的权限。
  - 请求授予工作流读取权限。
* - `404`
  - `ErrNotFound`
  - 工作流不存在或不属于当前工作区。
  - 核对工作区和工作流 ID。
* - `500`
  - `ErrServer`
  - 服务端读取失败。
  - 稍后重试。
```

## 后续操作

需要修改定义时[更新工作流](update-workflow.md)；准备运行时[启动工作流作业](../workflow-jobs/start-workflow-job.md)。