활성화/비활성화¶
POST /api/v1/checker/set_disable
개요¶
모니터 및 기존 스케줄을 일괄 활성화 또는 비활성화합니다.
호출 전 및 사용 단계¶
각 규칙의 현재 상태, 작업 권한 및 스케줄 후 시작/중지를 확인합니다. 서버는 규칙과 기존 기본/보조/워크스페이스 간 스케줄 스위치를 동기화하여 업데이트합니다. 작업을 다시 생성하거나 재실행하지 않습니다. 빈 배열이거나 모두 일치하지 않는 경우에도 true를 반환할 수 있으며, 항목별 결과는 없습니다. 자체 구축 점검은 이 API에서 생성한 주기 스케줄이 없으며, 실제 실행은 비즈니스 통합 측에서 제어합니다. 현재 공유 활성화 경로는 각 과거 워크스페이스 간 스케줄의 최신 권한을 다시 확인하지 않으며, 활성화 성공이 소스 데이터 조회 가능성을 보장하지 않으므로 실제 검증이 필요합니다. 비동기 참조 작업은 시작/중지 시 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. |
|
| isDisable | boolean | Y | 필수 불리언이며 각각 status=2/0으로 설정하고, 삭제된 규칙은 복구하지 않습니다. 활성화해도 이미 유실된 스케줄을 다시 생성하지 않습니다. null 허용: False 예시: true가져오기 또는 입력 방법: true는 비활성화, false는 활성화입니다. |
| ruleUUIDs | array | Y | 필수 배열이며 비어 있지 않은 것을 권장합니다. 이러한 공유 메서드는 모니터 카테고리를 추가로 제한하지 않으므로, rul_ 접두사만으로 다른 Rule 리소스 UUID를 섞어서는 안 됩니다. null 허용: False 예시: ["rul_checker_example"]가져오기 또는 입력 방법: 모니터 목록에서 대상 type별로 이 워크스페이스의 uuid를 항목별로 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/checker/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"ruleUUIDs":["rul_checker_example"],"isDisable":true}'
응답¶
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를 제공하십시오. |