# 重试工作流作业

重试一个工作流作业。请求成功不表示重试已完成；请查询新作业的详情确认状态。

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

## 调用前准备

先[查询作业详情](../workflow-jobs/get-workflow-job.md)，确认作业当前状态支持重试。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$WORKFLOW_ID`：作业所属的工作流 ID。
- `$EXECUTION_ID`：要重试的作业执行 ID。

## 路径参数

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `workflow_id` | string | 工作流 ID。 |
| `execution_id` | string | 要重试的作业 ID。 |

## 请求体

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `values` | object | 否 | 重试时使用的运行时输入值。 |
| `trigger_now` | boolean | 否 | 是否立即触发重试。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/$WORKFLOW_ID/executions/$EXECUTION_ID/retry" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "trigger_now": true
  }'
```

## 成功响应

成功时返回 `200`。`data.workflow_run` 返回重试请求对应的执行信息；保存新的执行 ID，用于查询重试作业的状态。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workflow_run": {
      "execution_id": "exec-002",
      "workflow_id": "wf-001",
      "status": "submitted",
      "execution_mode": "one_shot"
    }
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.workflow_run.execution_id` | string | 新的作业 ID。 |
| `data.workflow_run.workflow_id` | string | 工作流 ID。 |
| `data.workflow_run.status` | string | 新作业的当前状态。 |
| `data.workflow_run.execution_mode` | string | 工作流执行模式。 |
| `data.workflow_run.available_actions` | string（字符串数组） | 当前可用操作；仅在有值时返回。 |
| `data.workflow_run.error` | string | 作业错误信息；仅在有错误时返回。 |

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 请求体无效，或作业当前状态不支持重试。
  - 检查路径和请求体，并先读取作业状态。
* - `401`
  - `ErrUnauthorized`
  - 凭据缺失或无效。
  - 检查 API Key。
* - `403`
  - `ErrForbidden`
  - 当前身份没有运行权限。
  - 使用有权限的凭据，或联系管理员授权。
* - `404`
  - `ErrNotFound`
  - 工作流或作业不存在。
  - 检查路径参数。
* - `409`
  - `ErrConflict`
  - 当前作业状态与重试操作冲突。
  - 读取作业详情后按当前状态处理。
* - `500`
  - `ErrServer`
  - 服务端无法创建重试作业。
  - 记录请求时间和错误信息后重试。
* - `503`
  - `ErrServiceUnavailable`
  - 依赖服务不可用。
  - 稍后重试。
```

## 后续操作

使用新的执行 ID[查询工作流作业详情](../workflow-jobs/get-workflow-job.md)。
