콘텐츠로 이동

인시던트 AI 자동 분석 구성 설정



POST /api/v1/incidents/config/ai_analysis/set

개요

현재 워크스페이스의 인시던트 AI 자동 분석 스위치를 설정합니다.

호출 전 및 사용 단계

현재 Key에는 incidents.incidentsManage 권한이 필요합니다. 현재 Key가 속한 워크스페이스에만 적용되며, workspaceUUID 또는 플랫폼 일괄 워크스페이스 목록은 허용되지 않습니다. 이 스위치는 인시던트 AI 자동 분석만 제어하며, 인시던트 집계 스위치, AI 전체 활성화 또는 즉시 1회 분석 실행이 아닙니다. 실제 작업에서는 워크스페이스 AI 기능/서비스 가용성도 확인합니다. 활성화해도 모든 인시던트에 대해 응답이 생성되는 것은 아니며, 이 구성 요청으로 모든 과거 인시던트가 즉시 재분석되지도 않습니다. 비활성화하면 새 작업/아직 시작되지 않은 분석에서 스위치를 다시 확인하며, 저장 성공만으로 실행 중인 AI 요청이 종료되었거나 과거 응답이 삭제되었음을 증명할 수 없습니다.

JSON 불리언 enableAIAnalysis를 반드시 명시적으로 전달해야 합니다. true는 활성화, false는 비활성화이며 생략 시 기본값이 없고 null 또는 문자열은 허용되지 않습니다. 구성이 없으면 새로 생성하고, 기존 구성은 이 스위치만 갱신하며 다른 extend 구성은 유지합니다. 동일한 값을 반복 설정해도 업데이트 시간/감사 기록이 남을 수 있습니다. AI 작업 ID나 분석 성공 결과가 아닌 저장된 값을 반환합니다. 실패/시간 초과 시에는 먼저 조회 API로 현재 상태를 확인합니다.

요청 헤더

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

Body 요청 파라미터

파라미터명 타입 필수 설명
enableAIAnalysis boolean Y 필수 boolean이며 true는 활성화, false는 비활성화입니다. 생략/null 기본값이 없으며 AI 서비스가 이미 사용 가능함을 의미하지 않습니다.
null 허용: False
예: true
획득 또는 입력 방법: 현재 워크스페이스 관리자가 인시던트 AI 분석 활성화 여부를 확인합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/incidents/config/ai_analysis/set' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"enableAIAnalysis":true}'

응답

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

필드 타입 설명
content.enableAIAnalysis boolean 현재 워크스페이스의 인시던트 AI 자동 분석 구성이며, 활성 구성 레코드가 없으면 false입니다.
content.declaration object 현재 워크스페이스의 공용 선언입니다.
{
  "code": 200,
  "content": {
    "enableAIAnalysis": true,
    "declaration": {}
  },
  "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 파일 형식 오류 enableAIAnalysis를 포함하는 객체를 제출합니다.
500 ft.InternalServerError 데이터베이스 또는 처리되지 않은 시스템 예외 내부 오류 조회 API는 백오프 재시도가 가능하며, 쓰기 API는 먼저 구성을 다시 읽어 저장 여부를 확인한 뒤 동일한 목표 값으로 재시도합니다.

문서 평가

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