Get Workflow Steps API

출처: 문서

본문

Get Workflow Steps API

이 API는 워크플로 스텝 목록을 반환하며, 여기에는 각 스텝에 필요한 입력, 출력, 기본 타임아웃 값, 필수 플러그인도 포함되어 있어요. 예를 들어 register_remote_model 스텝의 경우 Get Workflow Steps 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}

쿼리 파라미터

다음 표는 사용 가능한 쿼리 파라미터를 정리한 거예요. 모든 쿼리 파라미터는 선택 사항이에요.

요청 예제

모든 워크플로 스텝을 가져오려면 다음 요청을 사용하세요:

GET /_plugins/_flow_framework/workflow/_steps

{% include copy-curl.html %}

특정 워크플로 스텝을 가져오려면 스텝 이름을 쿼리 파라미터로 요청에 전달하세요:

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

{% include copy-curl.html %}

응답 예제

OpenSearch는 워크플로 스텝과 함께 응답해요. 반환된 스텝에서 필드 순서는 원본 JSON과 정확히 일치하지 않을 수 있지만 기능은 동일하게 동작해요.

템플릿을 YAML 형식으로 가져오려면 요청 헤더에 Content-Type: application/yaml을 지정하세요:

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

템플릿을 JSON 형식으로 가져오려면 요청 헤더에 Content-Type: application/json을 지정하세요:

curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/_steps" -H 'Content-Type: application/json'

더 알아보기 (Learn more)

• 원문 전체: https://docs.opensearch.org/latest/automating-configurations/api/get-workflow-steps/