Delete Workflow API

출처: 문서

본문

Delete Workflow API

워크플로 템플릿이 더 이상 필요 없어지면 Delete Workflow API를 호출해서 삭제할 수 있어요.

워크플로를 삭제하면 저장된 템플릿만 삭제된다는 점에 유의하세요---리소스가 프로비저닝 해제되지는 않아요.

워크플로가 삭제되면 그에 대응하는 상태(Workflow State API가 반환하는)도 함께 삭제돼요. 단, 프로비저닝 상태가 IN_PROGRESS이거나 리소스가 이미 프로비저닝된 경우는 예외예요.

엔드포인트

DELETE /_plugins/_flow_framework/workflow/{workflow_id}

경로 파라미터

다음 표는 사용 가능한 경로 파라미터를 보여줘요.

쿼리 파라미터

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

요청 예시

DELETE /_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50

{% include copy-curl.html %}

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

{% include copy-curl.html %}

응답 예시

워크플로가 존재하면 삭제 응답에 삭제 상태가 담겨요. 성공하면 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
}

더 알아보기 (Learn more)

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