# 暂停工作流

暂停指定工作流。暂停会在安全调度边界处理该工作流下的运行中执行；不要据此推断外部系统已回滚副作用。

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

## 调用前准备

先[查询工作流详情](get-workflow.md)，检查 `available_actions` 是否包含暂停。准备有目标工作区访问权限的个人访问令牌和目标工作区 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 -X POST "https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/$WORKFLOW_ID/pause" \
  -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",
      "status": "paused",
      "available_actions": ["resume", "update", "delete"],
      "execution_summary": {
        "total_executions": 8,
        "active_executions": 1
      },
      "trigger_summary": {
        "mode": "cron",
        "configured": true,
        "enabled": false
      }
    }
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.workflow.id` | string | 工作流 ID。 |
| `data.workflow.status` | string | 暂停后的工作流状态。 |
| `data.workflow.available_actions` | string（字符串数组） | 当前允许的后续操作。 |
| `data.workflow.name` | string | 工作流名称。 |
| `data.workflow.description` | string | 工作流说明；未设置时可能省略。 |
| `data.workflow.source_type` | string | 来源类型。 |
| `data.workflow.execution_mode` | string | 执行模式。 |
| `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.dsl_yaml` | string | 工作流 DSL YAML。 |
| `data.workflow.runtime_fields` | object | 运行时输入表单；未配置时可能省略。 |
| `data.workflow.runtime_layout` | object | 运行时表单布局；未配置时可能省略。 |
| `data.workflow.default_values` | object | 运行时默认值；未配置时可能省略。 |
| `data.workflow.run_context` | object | 工作流运行上下文；未配置时可能省略。 |
| `data.workflow.moi_workflow_def_id` | string | 工作流定义标识；服务端提供时返回。 |
| `data.workflow.latest_workflow_version_id` | string | 最新工作流版本标识；服务端提供时返回。 |
| `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.execution_summary` | object | 执行数量和活动执行汇总。 |
| `data.workflow.trigger_summary` | object | 触发器模式、配置和启用状态。 |
| `data.workflow.created_at` | string | 创建时间；服务端提供时返回。 |
| `data.workflow.updated_at` | string | 最后更新时间；服务端提供时返回。 |

## 错误响应

```json
{
  "code": "ErrConflict",
  "msg": "资源状态冲突",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 工作流状态或请求参数不允许暂停。
  - 先读取工作流详情并检查 `available_actions`。
* - `401`
  - `ErrUnauthorized`
  - 缺少或无效的访问凭据。
  - 检查 API Key 和工作区 Header。
* - `403`
  - `ErrForbidden`
  - 当前身份没有工作流管理权限。
  - 请求授予工作流管理权限。
* - `404`
  - `ErrNotFound`
  - 工作流不存在或不属于当前工作区。
  - 核对工作区和工作流 ID。
* - `409`
  - `ErrConflict`
  - 当前状态与暂停动作冲突。
  - 重新读取详情后决定下一步。
* - `500`
  - `ErrServer`
  - 服务端处理失败。
  - 稍后重试。
```

## 后续操作

需要继续时[恢复工作流](resume-workflow.md)。