Link Search Menu Expand Document Documentation Menu
文档

删除工作流

当您不再需要工作流模板时，可以通过调用删除工作流 API 来将其删除。

请注意，删除工作流仅删除存储的模板——它不会取消配置其资源。

删除工作流后，其相应状态（由工作流状态 API 返回）也将被删除，除非配置状态为IN_PROGRESS或资源已配置。

端点

DELETE /_plugins/_flow_framework/workflow/<workflow_id>

路径参数

下表列出了可用的路径参数。

参数 数据类型 描述
workflow_id 字符串 要检索的工作流的 ID。必需。

查询参数

下表列出了可用的查询参数。所有查询参数都是可选的。

参数 数据类型 描述
clear_status 布尔型 确定在删除模板后是否删除工作流状态（而不取消配置资源）。OpenSearch 仅在配置状态不是IN_PROGRESS时才删除工作流状态。默认值为false。

请求示例

DELETE /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50


DELETE /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50?clear_status=true

示例响应

如果工作流存在，删除响应将包含删除状态，其中result字段在成功时设置为deleted，如果工作流不存在（可能已被删除），则设置为not_found。

{
  "_index": ".plugins-flow_framework-templates",
  "_id": "8xL8bowB8y25Tqfenm50",
  "_version": 2,
  "result": "deleted",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 2,
  "_primary_term": 1
}
剩余 350 字符

有问题？。

想做贡献？或。