API Reference
Job 전체 취소
요청 시작 시점에 계정의 모든 API 키로 만든 Pending(대기) Job을 전체 취소합니다.
POST
테스트하기/v1/api/job/cancel-all요청 예제
bash
curl --fail-with-body --silent --show-error --max-time 30 \
-X POST "$NORDY_BASE_URL/v1/api/job/cancel-all" \
-H "api-key: $NORDY_API_KEY"성공 응답200 OK
JSON
{"canceled_count": 3}인증
api-keystring필수사용자 API key를 api-key request header에 넣습니다.
성공 응답
200 OK
canceled_countintegerresponse필수- 새로 취소한 건수이며 취소할 작업이 없으면 0입니다.
참고
- 요청 본문은 필요하지 않습니다.
- 조회 응답이 queued여도 실행 준비가 시작된 Job은 제외합니다.
- 시간 초과나 오류가 나도 일부 Job은 취소됐을 수 있습니다. 상태를 확인한 뒤 다시 요청하세요. 재요청에는 그사이 생성된 Job도 포함됩니다.
응답과 오류
| Status | Code | 설명 |
|---|---|---|
| 400 | MULTIPLE_AUTH_CREDENTIALS | 로그인 쿠키를 제외하고 API 키만 보내세요. |
| 401 | AUTHENTICATION_REQUIRED | API 키가 없거나 유효하지 않습니다. |
| 403 | USER_SUSPENDED, PRO_SUBSCRIPTION_REQUIRED, INVALID_INPUT | 계정이 정지되었거나 Pro 구독이 없거나 API 이용이 제한되었습니다. |
| 500 | INTERNAL_ERROR | 요청 처리 중 서버 오류가 발생했습니다. |