요청 예제
bash
curl --fail-with-body --silent --show-error --max-time 30 \
-X POST "$NORDY_BASE_URL/v1/api/job/cancel" \
-H "api-key: $NORDY_API_KEY" \
-H "content-type: application/json" \
--data '{"job_ids":["68abcdef0123456789abcdef"]}'성공 응답200 OK
JSON
{
"canceled_count": 1,
"results": [
{ "id": "68abcdef0123456789abcdef", "status": "canceled" }
]
}인증
api-keystring필수사용자 API key를 api-key request header에 넣습니다.
요청 본문
Content-Type: application/json
job_idsstring[]body필수- 24자리 16진수 Job ID를 1~1,000개 전달하세요. 중복 ID는 한 번만 처리하며, 잘못된 입력이 있으면 취소 전에 요청 전체를 거절합니다.
성공 응답
200 OK HTTP 200이어도 취소하지 못한 Job이 있을 수 있으므로 results[].status를 확인하세요.
canceled_countintegerresponse필수- 이번 요청에서 새로 취소한 건수입니다.
results[].idstringresponse필수- 요청한 Job ID입니다.
results[].statuscanceled | already_canceled | not_cancelable | not_foundresponse필수- canceled는 취소 성공, already_canceled는 이미 취소됨, not_cancelable은 실행 준비가 시작됐거나 종료된 작업입니다. not_found는 없거나 다른 계정 소유이거나 API 작업이 아닌 경우입니다.
참고
- 같은 계정의 다른 API 키로 만든 Job도 취소할 수 있습니다.
- 조회 응답의 queued에는 취소할 수 없는 실행 준비 중 Job도 포함됩니다.
응답과 오류
| Status | Code | 설명 |
|---|---|---|
| 400 | INVALID_JSON, INVALID_INPUT | 올바른 job_ids 배열을 전달하세요. |
| 413 | REQUEST_BODY_TOO_LARGE | JSON 본문이 50 MiB를 초과했습니다. |
| 415 | UNSUPPORTED_MEDIA_TYPE | Content-Type: application/json으로 요청하세요. |
| 400 | MULTIPLE_AUTH_CREDENTIALS | 로그인 쿠키를 제외하고 API 키만 보내세요. |
| 401 | AUTHENTICATION_REQUIRED | API 키가 없거나 유효하지 않습니다. |
| 403 | USER_SUSPENDED, PRO_SUBSCRIPTION_REQUIRED, INVALID_INPUT | 계정이 정지되었거나 Pro 구독이 없거나 API 이용이 제한되었습니다. |
| 500 | INTERNAL_ERROR | 요청 처리 중 오류가 발생했습니다. 작업 상태를 확인한 뒤 다시 시도하세요. |