Get Workflow Status API

출처: 문서

본문

Get Workflow Status API

워크플로 프로비저닝에는 상당한 시간이 걸릴 수 있어요. 특히 이 작업이 OpenSearch 인덱싱 작업과 연관된 경우에 그래요. Get Workflow State API를 사용하면 프로비저닝 배포 상태를 완료될 때까지 모니터링할 수 있어요.

엔드포인트

GET /_plugins/_flow_framework/workflow/{workflow_id}/_status

경로 파라미터

사용할 수 있는 경로 파라미터는 다음 표에 나와 있어요.

쿼리 파라미터

all 파라미터는 응답에서 모든 필드를 반환할지 여부를 지정해요.

false(기본값)로 설정하면 응답에 다음 필드가 포함돼요:

• workflow_id
• error 상태(있는 경우)
• state
• 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

{% include copy-curl.html %}

예제 요청

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

{% include copy-curl.html %}

예제 응답

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"
    }
  ]
}

더 알아보기 (Learn more)

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