본문으로 건너뛰기
버전: 2602.1

분석 중지 API

POSThttps://ondemand.sparrowcloud.ai/api/v2/analysis/{analysisId}/stop

설명

사용자가 분석을 수행하도록 요청한 후에 분석을 중지하려는 경우 분석 중지 API를 전송할 수 있습니다. 중지하도록 요청한 분석은 다시 수행할 수 없으므로 유의하시기 바랍니다.

요청​

분석 중지를 요청하기 위해서는 분석 ID가 필요합니다. 분석 요청 API의 응답에서 받은 분석 ID를 확인하세요.

응답​

분석 중지 API를 전송하면 분석의 진행 상태에 따라 결과가 성공 또는 실패할 수 있습니다. 자세한 내용은 응답을 참고하세요.

요청

pathName :analysisIdapi 스펙과 일치하지 않는 pathName 입니다.

응답

✔️ 성공 응답​

요청 성공​

분석 중지 요청을 정상적으로 처리하면 200 OK를 응답으로 받습니다.

진행 중인 분석​

진행 중인 분석의 경우 분석 상태에 따라 동작이 다릅니다.

다음과 같이 진행 중인 분석의 경우 200 OK 응답을 수신하고 분석이 중지됩니다.

  • INIT : 분석 수행을 위한 자원할당이 완료된 후 중지 프로세스를 수행합니다.
  • READY, PRE_PROCESS, ANALYSIS: 분석을 즉시 중지합니다.

후처리 중인 분석의 경우 200 OK 응답을 수신하지만 분석이 중지되지 않습니다.

  • POST_PROCESS: 분석이 중지되지 않습니다.



❌ 실패 응답​

인증 실패​

인증 정보가 올바르지 않은 경우 401 Unauthorized를 수신합니다.

잘못된 요청​

잘못된 요청인 경우 400 Bad Request를 수신합니다.

존재하지 않는 분석​

존재하지 않는 분석에 대한 요청을 전송한 경우 400 Bad Request를 수신합니다.

종료된 분석​

  • COMPLETE: 400 Bad Request로 응답합니다. 분석이 완료되어 중지할 분석이 없습니다.

이미 중지된 분석​

  • STOP: 400 Bad Request로 응답합니다. 분석이 중지되어 중지할 수 없습니다.

여기에 다음과 같은 정보를 추가로 표시합니다.

  • resultCode: 요청에 대한 결과를 코드로 표시합니다. 자세한 내용은 결과 코드 모음을 참고하세요.
  • message : 오류 메시지를 표시합니다.