삭제¶
POST /api/v1/checker/delete
개요¶
모니터, 스케줄 및 연결된 참조를 일괄 삭제합니다.
호출 전 확인 및 사용 단계¶
먼저 모든 대상 UUID와 영향을 확인하고, 현재 워크스페이스의 모니터 목록에서 항목별로 선택합니다. 연결된 메인/보조/교차 워크스페이스 스케줄을 동기적으로 삭제한 다음, 규칙을 소프트 삭제하고 현재 워크스페이스 관련 EntityRef 참조를 정리합니다. 기존 이벤트와 원본 모니터링 데이터는 규칙 삭제와 함께 삭제되지 않습니다. 삭제 대상이 아닌 항목이 하나 이상 매칭되어야 계속 진행하며, 빈 배열이거나 전혀 매칭되지 않으면 ObjectNotExists를 반환합니다. 현재 메서드는 type을 제한하지 않으므로 이 모듈의 규칙 UUID만 사용해야 하며, 다른 Rule을 실수로 삭제해서는 안 됩니다. 일부 UUID가 매칭되지 않아도 항목별로 오류를 보고하지 않습니다. 참조 정리는 전체 입력 집합을 기준으로 수행되므로, 소유자 없는 구성이 매칭되지 않았다는 사실만으로 해당 워크스페이스 참조가 영향을 받지 않았다고 판단할 수 없습니다. 연결된 SLO 등 참조는 이후 비동기적으로 새로 고쳐지며, 완료되기 전까지 페이지 상태가 지연될 수 있습니다.
각 대상에 대해 사용자 정의 작업 권한을 개별적으로 검증하며, API Key 인터페이스 권한도 여전히 필요합니다. 스케줄 서비스, 데이터베이스 커밋, 참조 정리 및 비동기 디스패치는 서비스 간 원자적 트랜잭션이 아닙니다. 예외 발생 시 일부 상태/스케줄이 이미 업데이트되었을 수 있으므로, HTTP 200만으로 검증하지 말고 구성과 스케줄의 현재 상태를 다시 읽은 후 재시도합니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| ruleUUIDs[*] | string | 그룹, 히스토리, SLO 또는 생성된 메트릭 UUID가 아닙니다. 예: rul_checker_example획득 또는 입력 방법: 현재 워크스페이스에서 작업 가능한 모니터 uuid입니다. |
|
| ruleUUIDs | array | Y | 필수 배열이며 비어 있지 않을 것을 권장합니다. 이러한 공유 메서드는 모니터 카테고리를 추가로 제한하지 않으므로 rul_ 접두사만으로 다른 Rule 리소스 UUID를 섞어서는 안 됩니다. null 허용: False 예: ["rul_checker_example"]획득 또는 입력 방법: 모니터 목록에서 대상 type별로 현재 워크스페이스의 uuid를 항목별로 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/checker/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"ruleUUIDs":["rul_checker_example"]}'
응답¶
HTTP 200, application/json입니다. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true이며, 항목별 매칭 수나 다운스트림 실행 검증 결과가 아닙니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON Body 최상위가 객체가 아님(배열/문자열 등) | 일부 json 파일 형식 오류 | 예시에 따라 JSON 객체를 제출해야 하며, checkers 또는 event 배열을 그대로 제출할 수 없습니다. |
| 403 | ft.ForbiddenCheckerOperation | 대상 일반 모니터 작업 권한이 없음 | 모니터【{}】에 대한 작업 권한이 없습니다 | owner 또는 규칙에서 허용된 작업 주체를 사용하고 API Key 권한을 확인합니다. |
| 403 | ft.ForbiddenSmartCheckerOperation | 대상 지능형/AI 모니터링 작업 권한이 없음 | 지능형 모니터링【{}】에 대한 작업 권한이 없습니다 | 해당 규칙의 permissionSet과 작업 주체를 확인합니다. |
| 400 | ft.OuterFuncFailed | 스케줄 일괄 시작/중지/삭제가 명확한 비즈니스 실패를 반환함 | 외부 함수 호출 실패 | 스케줄과 규칙 상태를 확인한 후 재시도하고 traceId를 제공합니다. |
| 500 | ft.InternalServerError | 스케줄 연결/타임아웃/유효하지 않은 JSON 등 포착되지 않은 예외, 스토리지, 참조 또는 커밋 후 비동기 디스패치 실패 | 내부 오류 | 먼저 각 객체와 스케줄의 현재 상태를 읽고 완료된 단계를 확인한 후 대상에 맞게 재시도하며 traceId를 제공합니다. |
| 404 | ft.ObjectNotExists | 현재 워크스페이스에 삭제되지 않은 규칙 매칭이 하나도 없음([] 포함) | 지정한 객체가 존재하지 않음 | 현재 목록에서 유효한 UUID를 다시 가져옵니다. 이미 삭제된 객체는 이 응답으로 다시 복구할 수 없습니다. |