Link Search Menu Expand Document Documentation Menu
文档

获取工作流状态

预置工作流可能需要大量时间，特别是当操作与 OpenSearch 索引操作相关联时。获取工作流状态 API 允许监控预置部署状态，直到其完成。

端点

GET /_plugins/_flow_framework/workflow/<workflow_id>/_status

路径参数

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

参数 数据类型 描述
workflow_id 字符串 要获取状态的工作流 ID。对于 PUT 方法是必需的。

查询参数

The all 参数指定响应是否应返回所有字段。

当设置为 false（默认值）时，响应包含以下字段：

  • workflow_id
  • 任何 error 状态
  • 状态
  • 一个 resources_created 列表

当设置为 true 时，响应包含以下附加字段：

  • provisioning_progress
  • provision_start_time
  • provision_end_time
  • user
  • user_outputs

要接收响应中的所有可用字段，请将 all 设置为 true

GET /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50/_status?all=true

请求示例

GET /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50/_status

示例响应

OpenSearch 返回预置状态的摘要和已创建资源的列表。

在预置开始之前，OpenSearch 不会返回任何资源

{
  "workflow_id" : "8xL8bowB8y25Tqfenm50",
  "state": "NOT_STARTED"
}

在预置进行中时，OpenSearch 会返回部分资源列表

{
  "workflow_id" : "8xL8bowB8y25Tqfenm50",
  "state": "PROVISIONING",
  "resources_created": [
    {
      "workflow_step_name": "create_connector",
      "workflow_step_id": "create_connector_1",
      "resource_type": "connector_id",
      "resource_id": "NdjCQYwBLmvn802B0IwE"
    }
  ]
}

预置完成后，OpenSearch 会返回完整的资源列表

{
  "workflow_id" : "8xL8bowB8y25Tqfenm50",
  "state": "COMPLETED",
  "resources_created": [
    {
      "workflow_step_name": "create_connector",
      "workflow_step_id": "create_connector_1",
      "resource_type": "connector_id",
      "resource_id": "NdjCQYwBLmvn802B0IwE"
    },
    {
      "workflow_step_name": "register_remote_model",
      "workflow_step_id": "register_model_2",
      "resource_type": "model_id",
      "resource_id": "N9jCQYwBLmvn802B0oyh"
    }
  ]
}
剩余 350 字符

有问题？。

想贡献？或。