수집 취소 V2

POST api.hashscraper.com/api/cancel_collect Content-Type: application/json; version=2

진행 중인 데이터 수집을 중단하도록 신호를 보냅니다.

호출 즉시 워커가 멈추는 것이 아니라, 워커가 다음 점검 시점에 취소 신호를 감지하면 진행 중이던 작업을 정리합니다.

응답 직후 데이터셋의 sr_status는 canceling으로 바뀌며, 실제 작업이 종료되면 finish로 마무리됩니다. 취소 진행 상황은 collect_status에서 확인할 수 있습니다.

이미 finish 상태인 데이터셋에 호출하면 수집된 결과는 그대로 유지되지만 sr_status가 canceling으로 바뀌어 남습니다. 워커가 더 이상 동작하지 않으므로 자동으로 정리되지 않으니, 호출 전 collect_status로 진행 상태를 먼저 확인하는 것이 좋습니다.

요청 파라미터

  • api_key: String
    해시스크래퍼 API 키API키 확인하기
    예시 YOUR_API_KEY
  • schedule_result_id: Integer
    취소할 데이터셋 ID. collect 응답으로 받은 값을 그대로 전달합니다.
    예시 YOUR_SCHEDULE_RESULT_ID

응답 필드

  • result: String
    요청 처리 결과.
    허용값 success, error
  • version: String
    API 버전.
    예시 v2
  • cancel_info: Object
    취소 요청 결과 정보.
    • schedule_result_id: Integer
      취소 요청한 데이터셋 ID. 요청 시 전달한 값과 동일합니다.
    • schedule_id: String
      이 데이터셋이 속한 스크래퍼의 식별자. 서버에 저장된 값을 반환합니다.
    • param_info: Object
      이 데이터셋이 처음 수집된 시점의 파라미터 스냅샷. 사용으로 지정된 param1~param5만 포함되며, 키 이름에 라벨이 함께 표기됩니다 (예: param1(검색어)). 스크래퍼에 라벨이 설정되지 않았으면 param1() 또는 param1(param1)처럼 라벨 자리가 비거나 placeholder로 남을 수 있습니다.
  • elapsed_time: Float
    응답 생성에 걸린 시간(초 단위 숫자).
    예시 0.0234

에러 응답

  • schedule_result_id missing
    필수 파라미터 schedule_result_id가 누락되었습니다.
    {
  "result": "error",
  "version": "v2",
  "message": "`schedule_result_id` parameter is required"
}
  • Schedule result not found
    전달된 schedule_result_id로 데이터셋을 찾을 수 없거나 접근 권한이 없습니다.
    {
  "result": "error",
  "version": "v2",
  "message": "schedule_result(id: YOUR_SCHEDULE_RESULT_ID) not found"
}

관련 가이드

요청 예시
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
응답 예시 200 
{
  "result": "success",
  "version": "v2",
  "cancel_info": {
    "schedule_result_id": 13229289,
    "schedule_id": "사람인_채용공고_수집_1697441449957",
    "param_info": {
      "param1(검색할 키워드)": "개발자",
      "param2(최대 수집 개수)": "10"
    }
  },
  "elapsed_time": 0.0234
}