콘텐츠로 이동

자동 발견 구성 비활성화/활성화



POST /api/v1/issue_auto_discovery/{cfg_uuid}/set_disable

개요

Issue 자동 발견 규칙을 활성화 또는 비활성화합니다.

호출 전 및 사용 단계

이 모듈은 기존 인시던트 Issue 자동 발견 구성이며, 인시던트 센터 Incidents의 온콜/자동 집계가 아니고 오류 센터 ErrorTrack 규칙도 아닙니다. 현재 공개적으로 dqlNamespace에 기록할 수 있는 값은 keyevent뿐이며, rum/tracing 기존 예시는 현재 명세와 일치하지 않습니다. 백엔드에서 issueUpgrade=true로 마이그레이션된 워크스페이스는 이 v2 자동 발견 작업을 건너뛰므로, 구성 성공을 근거로 해당 워크스페이스에서 새 Issue가 생성된다고 보장할 수 없습니다.

권한은 trace.issueDiscovery/rum.issueDiscovery/anomaly.issueDiscovery 중 하나를 충족해야 합니다. 대상은 현재 워크스페이스의 삭제되지 않은 규칙이어야 하며, 알 수 없는 삭제/중복 삭제는 멱등적 성공이 아니며 404 ft.LogIndexCfgNoExists가 반환됩니다. 비활성화는 규칙 status를 2로 설정할 뿐이며, 이후 정기 조회/생성 시 현재 상태를 확인합니다. 이미 실행된 조회나 이미 발송된 알림을 취소할 수 없고, 진행 중인 작업이 즉시 취소됨을 보장하지도 않습니다. 활성화하면 정기 실행에 다시 참여하지만, 워크스페이스가 인시던트 센터로 마이그레이션된 경우의 건너뛰기 조건은 그대로 적용됩니다.

true를 반환하며, 매칭 수/실행 작업/알림 상태는 반환하지 않습니다. 구성을 저장해도 즉시 조회를 실행하거나 생성 작업을 반환하지 않습니다. 정기 실행은 Asia/Shanghai 캘린더에 맞춰 주기를 정렬하여 이전 every초 윈도우를 처리하며, 작업 큐/조회 소요 시간에 따라 지연될 수 있습니다. keyevent는 monitor 이벤트에서 집계되며, dimensions 기준으로 최대 1000개 그룹을 생성하고, 넓은 범위의 완전한 커버리지를 보장하지 않습니다. 그룹 차원을 정렬한 JSON으로 중복 식별자를 생성하며, 규칙 UUID는 이 식별자에 포함되지 않습니다. 같은 워크스페이스에서 동일한 차원 값을 가진 여러 규칙이 동일한 기존 Issue에 연결될 수 있고, 차원/필터를 수정하면 그룹 결과가 달라질 수 있습니다. 이를 규칙별로 독립적이며 절대 교차하지 않는 Issue 집합으로 간주하지 마세요. Open/Pending 상태에는 답글이 추가되고, Resolved는 재오픈되어 회귀할 수 있으며, Closed는 재사용되지 않습니다. 레거시 Working 분기는 실제 구현에 따라 처리되며, 작업 중 완전한 격리를 보장하지 않습니다. 알림은 비동기이며, HTTP 200이 데이터 조회 성공/새 Issue 생성/알림 전달을 의미하지 않습니다.

라우팅 파라미터

파라미터명 타입 필수 설명
cfg_uuid string Y 현재 Key 워크스페이스의 삭제되지 않은 규칙으로, 상태 0(활성화) 또는 2(비활성화) 모두 읽기/수정할 수 있습니다. 누락 시 하위 호환을 위해 ft.LogIndexCfgNoExists를 사용하지만, 메시지가 로그 인덱스라고 표시하더라도 실제로는 이 규칙 UUID를 확인해야 합니다.
예: iatdc_example
획득 또는 입력 방법: Issue 자동 발견 규칙 목록에서 content.data[].uuid(iatdc_)를 가져오며, Issue UUID나 ErrorTrack 규칙 UUID를 사용하지 마세요.

요청 헤더

파라미터명 타입 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 발급받습니다.

Body 요청 파라미터

파라미터명 타입 필수 설명
isDisable boolean Y 필수 불리언이며, 누락/null/문자열이면 406이 먼저 반환됩니다. true이면 status를 2로, false이면 0으로 설정하며, 같은 값이어도 업데이트 시간은 갱신됩니다.
null 허용: False
예: true
획득 또는 입력 방법: 호출자가 비활성화(true) 또는 활성화(false)를 명시적으로 결정합니다.

파라미터 추가 설명

현재 공개 범위는 keyevent이며, 구성 저장, 정기 실행, 알림 전달은 서로 다른 단계입니다. 파라미터와 전체 응답/오류 경계는 아래를 참조하세요.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/issue_auto_discovery/iatdc_example/set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"isDisable":true}'

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 타입 설명
content boolean 성공 시 true이며, declaration이나 작업/항목별 정보를 포함하지 않습니다.
{
  "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 최상위가 객체가 아님 일부 JSON 파일 형식 오류 isDisable 불리언 객체를 제출합니다.
404 ft.LogIndexCfgNoExists 현재 워크스페이스에 삭제되지 않은 자동 발견 규칙이 없음/삭제됨/다른 워크스페이스 지정한 로그 인덱스 구성이 존재하지 않음 현재 워크스페이스의 자동 발견 목록에서 iatdc_ UUID를 새로 고칩니다. 이는 하위 호환을 위해 재사용된 오류 문구이므로 로그 인덱스를 새로 만들지 마세요.
500 ft.InternalServerError 규칙 상태 저장/제출 또는 처리되지 않은 상태 업데이트 예외 내부 오류 먼저 규칙 상세에서 status가 이미 0/2인지 확인하고 traceId를 보존한 뒤, 동일 상태로 재시도할지 결정합니다. 재생성이나 이벤트 카운트 초기화와는 무관합니다.

문서 평가

이 페이지가 도움이 되었나요?