# 删除工作流作业

删除一个工作流作业记录。此操作不可逆。

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

## 调用前准备

先[查询作业详情](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。 |

## 请求示例

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

## 成功响应

当响应中的 `code` 为 `OK` 且 `data.deleted` 为 `true` 时，服务端已删除该作业记录。删除不可逆。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "deleted": true
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.deleted` | boolean | `true` 表示作业记录已删除。 |

## 错误响应

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

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 工作流 ID 或执行 ID 为空或无效。
  - 使用列表响应中的 ID。
* - `401`
  - `ErrUnauthorized`
  - 缺少或无效的访问凭据。
  - 检查 API Key 和工作区 Header。
* - `403`
  - `ErrForbidden`
  - 当前身份没有工作流删除权限。
  - 请求授予 `workflow.delete` 权限。
* - `404`
  - `ErrNotFound`
  - 作业不存在或不属于路径中的工作流。
  - 核对工作流 ID 和执行 ID。
* - `409`
  - `ErrConflict`
  - 当前作业状态与删除操作冲突。
  - 处理或等待当前执行后再删除。
* - `503`
  - `ErrServiceUnavailable`
  - 依赖服务暂不可用。
  - 稍后重试。
* - `500`
  - `ErrServer`
  - 服务端未能删除作业记录。
  - 稍后重试。
```

## 后续操作

[查询工作流作业列表](list-workflow-jobs.md)，确认该作业记录已不再出现。