삭제¶
POST /api/v1/self_built_checker/delete
개요¶
자체 구축 점검을 소프트 삭제합니다.
호출 전 및 사용 단계¶
이 API는 일치한 자체 구축 점검의 기본 레코드만 소프트 삭제하지만, 참조 정리는 전체 입력 UUID를 사용하며 참조 유형을 제한하지 않습니다(현재 워크스페이스로는 제한됨). 따라서 먼저 이 모듈 목록에서 항목별로 확인해야 하며, 일반 모니터링 등 다른 Rule UUID와 혼용해서는 안 됩니다. 기본 레코드가 일치하지 않더라도 동일 워크스페이스 내 다른 유형의 동일 UUID 참조가 정리될 수 있으므로, true를 부작용이 발생하지 않았다는 의미로 간주해서는 안 됩니다. 삭제 후에는 연관된 알림 정책 캐시가 비동기로 정리되며, 이미 생성된 이벤트/원시 데이터는 함께 삭제되지 않고 enable로 복구할 수 없습니다.
이 워크스페이스의 이 모듈 목록에 있는 UUID만 사용할 수 있습니다. refKey를 제공하면 UUID와 함께 필터링되며, 독립적인 일괄 지정 방식이 아닙니다. true를 반환하며 항목별 일치/변경 수는 제공하지 않습니다. 빈 배열이거나 일치하는 항목이 없어도 성공할 수 있으므로 상태/연관 관계는 다시 읽어 확인해야 합니다. 오류/타임아웃 발생 시 먼저 현재 구성 상태를 확인해야 하며, 삭제/제출 후 비동기 디스패치가 실패했더라도 이미 저장되었을 수 있습니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| refKey | string | 선택적 추가 필터 조건으로, 각 UUID와 동시에 일치합니다. UUID의 대체 파라미터가 아니며 refKey만 전달하여 집합을 조작할 수 없습니다. null 허용: False 예: custom-healthcheck-production가져오기 또는 입력 방법: 동일한 비즈니스 연관 키를 추가로 확인해야 할 때 입력합니다. |
|
| ruleUUID | string | 선언은 선택 사항이지만 호출자는 비어 있지 않은 이 워크스페이스의 자체 구축 점검 UUID를 명확히 제공해야 합니다. refKey만으로는 해당 객체가 자동 선택되지 않습니다. null 허용: False 예: rul_self_example가져오기 또는 입력 방법: 이 모듈 목록에서 대상 uuid를 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/self_built_checker/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"ruleUUID":"rul_self_example"}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true이며, 각 입력 UUID가 일치하거나 실제 변경되었음을 의미하지 않습니다. |
{
"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을 수정하세요. |
| 500 | ft.InternalServerError | 대상 미선택, 필드 형태 또는 길이 오류, 데이터베이스/제출 후 비동기 작업 디스패치 실패 등 | 내부 오류 | 먼저 현재 규칙을 다시 읽어 저장되었는지 확인하세요. 이 워크스페이스의 명확한 ruleUUID를 사용한 후 다시 시도하고 traceId를 제공하세요. |