Link Search Menu Expand Document Documentation Menu
文档

获取工作流步骤

此 API 返回工作流步骤列表，包括其所需的输入、输出、默认超时值和所需插件。例如，对于 register_remote_model 步骤，获取工作流步骤 API 返回以下信息

{
  "register_remote_model": {
    "inputs": [
      "name",
      "connector_id"
    ],
    "outputs": [
      "model_id",
      "register_model_status"
    ],
    "required_plugins": [
      "opensearch-ml"
    ]
  }
}

端点

GET /_plugins/_flow_framework/workflow/_steps
GET /_plugins/_flow_framework/workflow/_steps?workflow_step=<step_name>

查询参数

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

参数 数据类型 描述
workflow_step 字符串 要检索的步骤名称。以逗号分隔列表的形式指定多个步骤名称。例如，create_connector,delete_model,deploy_model。

请求示例

要获取所有工作流步骤，请使用以下请求

GET /_plugins/_flow_framework/workflow/_steps

要获取特定的工作流步骤，请将步骤名称作为查询参数传递给请求

GET /_plugins/_flow_framework/workflow/_step?workflow_steps=create_connector,delete_model,deploy_model

示例响应

OpenSearch 将响应工作流步骤。返回步骤中字段的顺序可能与原始 JSON 不完全匹配，但功能将完全相同。

要以 YAML 格式检索模板，请在请求头中指定 Content-Type: application/yaml

curl -XGET "https://:9200/_plugins/_flow_framework/workflow/_steps" -H 'Content-Type: application/yaml'

要以 JSON 格式检索模板，请在请求头中指定 Content-Type: application/json

curl -XGET "https://:9200/_plugins/_flow_framework/workflow/_steps" -H 'Content-Type: application/json'
剩余 350 字符

有问题？。

想做贡献吗？或。