데이터셋 수집 취소 V4

POST www.hashscraper.com/v4/api/schedule_results/{id}/cancel

진행 중인 데이터셋의 수집을 취소 요청합니다.

요청한 데이터셋의 취소 신호를 등록합니다. 워커는 다음 안전 지점에서 신호를 감지해 종료하므로 호출 즉시 멈추는 것은 보장되지 않습니다.

이미 종료된(finish·complete 등) 데이터셋에 호출해도 응답은 성공이지만 sr_status가 canceling으로 덮여 표시되므로, 진행 중일 때만 사용하세요.

취소가 끝나면(작업이 모두 정리되면) sr_status는 canceled(취소 완료)로 바뀝니다. 2026-09-27 부터 추가된 값입니다. 예전에는 canceling에 머물렀습니다.

요청 파라미터

  • Authorization: Header
    해시스크래퍼 API 키. Bearer <api_key> 형식으로 전달합니다.
    예시 Bearer YOUR_API_KEY
  • id: Integer (path)
    취소할 데이터셋 ID.
    예시 239758028

응답 필드

  • result: String
    요청 처리 결과.
    허용값 success, error
  • version: String
    API 버전.
    예시 v4
  • request_id: String
    요청 추적용 ID.
    예시 req_5a8c1f1c-...
  • elapsed_sec: Float
    응답 생성에 걸린 시간(초 단위 Float).
    예시 0.0153
  • data: Object
    취소 요청 직후 상태 스냅샷.
    • schedule_result_id: Integer
      취소 요청한 데이터셋 ID(echo, 요청 ID와 동일).
    • schedule_id: String
      데이터셋이 속한 크롤링 봇의 ID.
    • name: String
      데이터셋이 속한 크롤링 봇의 이름.
    • sr_status: String
      취소 요청 직후 상태. 일반적으로 canceling. 작업이 정리되면 canceled로 바뀝니다.
    • param_info: Object
      이 데이터셋의 파라미터 스냅샷. 키는 param1~paramN으로 안정적이며, 각 항목은 name(라벨)과 value를 포함합니다.

에러 응답

  • MISSING_API_KEY
    Authorization 헤더가 없거나 형식이 올바르지 않습니다. Authorization: Bearer <api_key> 형태로 전달하세요. (HTTP 401)
    {
      "result": "error",
      "version": "v4",
      "request_id": "req_5a8c1f1c-...",
      "code": "MISSING_API_KEY",
      "message": "API key is missing.",
      "elapsed_sec": 0.0008,
      "details": { "hint": "Send `Authorization: Bearer <api_key>` header." }
    }
  • INVALID_API_KEY
    전달된 API 키와 일치하는 사용자가 없습니다. (HTTP 401)
    {
      "result": "error",
      "version": "v4",
      "request_id": "req_5a8c1f1c-...",
      "code": "INVALID_API_KEY",
      "message": "API key is invalid.",
      "elapsed_sec": 0.0011
    }
  • SCHEDULE_RESULT_NOT_FOUND
    전달된 ID로 데이터셋을 찾을 수 없거나 접근 권한이 없습니다. (HTTP 404)
    {
      "result": "error",
      "version": "v4",
      "request_id": "req_5a8c1f1c-...",
      "code": "SCHEDULE_RESULT_NOT_FOUND",
      "message": "ScheduleResult not found.",
      "elapsed_sec": 0.0021,
      "details": { "resource": "schedule_result", "id": "999999" }
    }

관련 가이드

요청 예시
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
응답 예시 200
{
  "result": "success",
  "version": "v4",
  "request_id": "req_5a8c1f1c-9b2d-4e7c-9abf-3f7e0a4d1b21",
  "elapsed_sec": 0.0153,
  "data": {
    "schedule_result_id": 239758028,
    "schedule_id": "8f3a7c1e9b5d24f6",
    "name": "네이버 뉴스 검색",
    "sr_status": "canceling",
    "param_info": {
      "param1": { "name": "키워드", "value": "키성장" },
      "param2": { "name": "정렬",   "value": "관련도순" }
    }
  }
}