Skip to main content
Version: 2608.1

Stop Analysis API

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

Description

If you want to stop an analysis after requesting that it be performed, you can send the stop analysis API. Note that an analysis you have requested to stop cannot be run again.

Request​

To request that an analysis be stopped, you need the analysis ID. Check the analysis ID you 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 of the analysis. For details, see Response.

Request

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

Response

✔️ Success response​

Request succeeded​

When the stop analysis request is processed normally, you receive 200 OK as the response.

Analyses in progress​

For an analysis in progress, the behavior differs depending on the analysis status.

For an analysis in progress as follows, you receive a 200 OK response and the analysis is stopped.

  • INIT : the stop process runs after the resource allocation for the analysis is complete.
  • READY, PRE_PROCESS, ANALYSIS: the analysis is stopped immediately.

For an analysis in post-processing, you receive a 200 OK response but the analysis is not stopped.

  • POST_PROCESS: the analysis is not stopped.



❌ Failure response​

Authentication failure​

If the credentials are incorrect, you receive 401 Unauthorized.

Bad request​

For a bad request, you receive 400 Bad Request.

Nonexistent analysis​

If you send a request for an analysis that does not exist, you receive 400 Bad Request.

Completed analyses​

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

Already stopped analyses​

  • STOP: responds with 400 Bad Request. The analysis has been stopped, so it cannot be stopped.

The following information is additionally shown here.

  • resultCode: indicates the result of the request as a code. For details, see API result codes.
  • message : shows the error message.