콘텐츠로 이동

기본 설정 상태 조회



GET /api/v1/incidents/level/config/get

개요

현재 워크스페이스의 기본 인시던트 등급 활성화/비활성화 스위치를 읽습니다.

호출 전 및 사용 단계

Key는 routine.defaultAccess 또는 incidents.incidentsLevelManage 중 하나에 해당해야 하며, 현재 Key가 속한 워크스페이스에만 적용됩니다. 이 모듈은 Issue 등급 API와 등급 및 기본 등급 설정을 공유하므로, 변경 시 인시던트/Issue 등급 선택에 동시에 영향을 줄 수 있습니다. 본 모듈에만 독립적인 복사본이 생성되는 것은 아닙니다. 백엔드에서 전역 등급을 활성화한 경우 실제 유효 등급 선택은 전역 설정이 우선적으로 결정할 수 있으며, 현재 워크스페이스 관리 목록에는 여전히 기본 항목과 워크스페이스 사용자 지정 항목만 표시되고 백엔드 전역 등급은 포함되지 않습니다. 관리자는 적용 기준을 확인한 후 수정해야 하며, 관리 목록의 모든 항목을 사용 가능한 등급으로 간주해서는 안 됩니다.

설정 값 객체를 반환하며, 설정 데이터베이스 엔터티가 아닙니다. 설정 레코드가 없으면 isDisabled=false이며, 기본 4개 등급이 활성화된 상태입니다. 사용자 지정 등급 목록이나 백엔드 전역 스위치는 포함하지 않습니다. 인시던트 등급 목록을 조회하면 기본 항목과 사용자 지정 항목을 동시에 확인할 수 있지만, 실제 적용 규칙은 여전히 판단해야 합니다.

요청 헤더

매개변수 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/incidents/level/config/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

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

필드 유형 설명
content.isDisabled boolean 현재 워크스페이스의 기본 4개 등급 스위치입니다. false는 활성화, true는 비활성화입니다. 설정이 없으면 false입니다.
content.declaration object 현재 워크스페이스의 공통 선언입니다.
{
  "code": 200,
  "content": {
    "isDisabled": false,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
500 ft.InternalServerError 데이터베이스 읽기, 기존 객체/설정 형식 또는 연관 요약 구성 등에서 처리되지 않은 예외 내부 오류 쿼리 매개변수를 확인하고 traceId를 보관하십시오. 백오프 후 재시도할 수 있으며, 계속 실패하면 관리자가 관련 기존 레코드와 서비스 로그를 확인해야 합니다.

문서 평가

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