Skip to main content
Version: 2508.1

Stop Analysis API

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

Description

After a user requests analysis to be performed, they can send a stop analysis API to stop the analysis. Note that analyses that have been requested to be stopped cannot be performed again.

Request​

An Analysis ID is required to request analysis stop. Check the Analysis ID received in the response from the analysis request API.

Response​

When you send the stop analysis API, the result may be success or failure depending on the progress status of the analysis. For details, refer to Response.

Request

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

Response

✔️ Success Response​

Request Success​

If the stop analysis request is processed normally, you will receive 200 OK as a response.

Analysis in Progress​

For analyses in progress, the behavior differs according to the analysis status.

For analyses in progress as follows, you will receive a 200 OK response and the analysis will be stopped.

  • INIT : Performs the stop process after resource allocation for analysis is completed.
  • READY, PRE_PROCESS, ANALYSIS: Stops the analysis immediately.

For analyses in post-processing, you will receive a 200 OK response but the analysis will not be stopped.

  • POST_PROCESS: The analysis is not stopped.



❌ Failure Response​

Authentication Failure​

If authentication information is incorrect, you will receive 401 Unauthorized.

Invalid Request​

If the request is invalid, you will receive 400 Bad Request.

Non-existent Analysis​

If a request is sent for a non-existent analysis, you will receive 400 Bad Request.

Completed Analysis​

  • COMPLETE: Responds with 400 Bad Request. The analysis is completed, so there is no analysis to stop.

Already Stopped Analysis​

  • STOP: Responds with 400 Bad Request. The analysis is stopped, so it cannot be stopped again.

The following information is additionally displayed here.

  • resultCode: Displays the result of the request as a code. For details, refer to Result Code Collection.
  • message : Displays an error message.