콘텐츠로 이동

등급 목록



GET /api/v1/incidents/level/list

개요

현재 워크스페이스의 기본 및 사용자 지정 인시던트 등급 설정을 나열합니다.

호출 전 및 사용 단계

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

요청 매개변수가 없으며 페이지네이션하지 않습니다. 기본 네 항목은 항상 나열되며 isDisabled로 워크스페이스 기본 토글을 표시합니다. 사용자 지정 항목에는 isDefault=false 및 신원 요약이 추가됩니다. 목록을 읽을 때 비활성화된 기본 항목은 필터링되지 않습니다. 인시던트 등급을 선택하기 전에 토글/백엔드 전역 우선 규칙을 확인해야 하며, 관리 목록에 나타난다는 사실을 사용 가능의 증거로 삼지 마세요. 기본 항목에는 데이터베이스 id/creator 등 사용자 지정 엔터티 필드가 없으므로 클라이언트는 두 가지 형태를 모두 지원해야 합니다.

요청 헤더

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

매개변수 추가 설명

워크스페이스 기본 및 워크스페이스 사용자 지정 등급만 나열하며, 관리 백엔드의 전역 등급은 포함하지 않습니다. 기본 항목은 isDisabled=true로 표시될 수 있지만 여전히 관리 응답에 나열됩니다.

요청 예시

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

응답

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

필드 유형 설명
content array<object> 기본 네 항목이 먼저 오고, 워크스페이스 사용자 지정 항목은 createAt 내림차순입니다. 페이지네이션하지 않으며 백엔드 전역 등급을 포함하지 않습니다.
content[].uuid string 기본은 system_level_0/1/2/3, 사용자 지정은 issl_ 등입니다.
content[].name string 기본 이름 P0/P1/P2/알 수 없음은 언어 설정에 따라 반환되고, 사용자 지정은 저장된 값을 사용합니다.
content[].color string 표시 색상입니다.
content[].description string 등급 설명입니다.
content[].isDefault boolean 기본은 true, 사용자 지정은 false입니다.
content[].isDisabled boolean 또는 null 기본 항목에만 반환되며 워크스페이스 기본 등급 토글에서 가져옵니다. 비활성화되어도 관리 목록에 남아 있습니다.
content[].id integer 또는 null 데이터베이스 행 ID입니다. 비즈니스 식별에는 uuid를 사용하며, 제출 전 스냅샷은 null일 수 있습니다.
content[].status integer 데이터베이스 상태, 0 활성/3 삭제입니다. 인시던트 비즈니스 상태 incidentsStatus와 다릅니다.
content[].creator string 생성 주체이며, API Key는 일반적으로 wsak_ 리소스 UUID입니다.
content[].updator string 최근 업데이트 주체이며, 업데이트되지 않은 경우 비어 있을 수 있습니다.
content[].createAt integer Unix 초 생성 시간입니다.
content[].updateAt integer Unix 초 최근 업데이트 시간입니다.
content[].deleteAt integer Unix 초 삭제 시간이며, 삭제되지 않은 경우 -1입니다.
content[].workspaceUUID string 사용자 지정 항목에만 해당하며, 소속 워크스페이스입니다.
content[].extend JSON 또는 null 사용자 지정 항목에만 저장되는 확장입니다.
content[].extend.사용자 지정 필드 JSON 생성 측이 저장한 동적 확장 키-값입니다.
content[].isManage boolean 본 워크스페이스 사용자 지정은 일반적으로 false입니다.
content[].creatorInfo object 사용자 지정 항목에만 있는 주체 요약이며, 찾지 못하면 {}입니다.
content[].creatorInfo.uuid string 주체 UUID입니다. 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다.
content[].creatorInfo.status integer 주체 상태입니다.
content[].creatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태입니다. Key는 Key 상태를 사용하며 인시던트 상태가 아닙니다.
content[].creatorInfo.username string 로그인 이름/Key 이름/시스템 이름입니다.
content[].creatorInfo.name string 표시 이름입니다. 시스템 AI 표시 이름은 사이트 설정을 사용합니다.
content[].creatorInfo.iconUrl string 아바타 URL입니다. 시스템 요약에서는 생략될 수 있습니다.
content[].creatorInfo.email string 연락 이메일입니다. Key 요약은 Key UUID일 수 있으며 발송 가능한 이메일이 아닙니다.
content[].creatorInfo.mobile string 연락 휴대폰 번호이며 비어 있을 수 있습니다.
content[].creatorInfo.countryCode string 국가 코드입니다. 시스템 요약에서는 생략될 수 있습니다.
content[].creatorInfo.acntWsNickname string 워크스페이스 닉네임입니다. 시스템 요약에서는 생략될 수 있습니다.
content[].updatorInfo object 사용자 지정 항목에만 있는 주체 요약이며, 찾지 못하면 {}입니다.
content[].updatorInfo.uuid string 주체 UUID입니다. 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다.
content[].updatorInfo.status integer 주체 상태입니다.
content[].updatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태입니다. Key는 Key 상태를 사용하며 인시던트 상태가 아닙니다.
content[].updatorInfo.username string 로그인 이름/Key 이름/시스템 이름입니다.
content[].updatorInfo.name string 표시 이름입니다. 시스템 AI 표시 이름은 사이트 설정을 사용합니다.
content[].updatorInfo.iconUrl string 아바타 URL입니다. 시스템 요약에서는 생략될 수 있습니다.
content[].updatorInfo.email string 연락 이메일입니다. Key 요약은 Key UUID일 수 있으며 발송 가능한 이메일이 아닙니다.
content[].updatorInfo.mobile string 연락 휴대폰 번호이며 비어 있을 수 있습니다.
content[].updatorInfo.countryCode string 국가 코드입니다. 시스템 요약에서는 생략될 수 있습니다.
content[].updatorInfo.acntWsNickname string 워크스페이스 닉네임입니다. 시스템 요약에서는 생략될 수 있습니다.
content[].declaration object 각 비어 있지 않은 항목의 현재 워크스페이스 공통 선언입니다.
{
  "code": 200,
  "content": [
    {
      "name": "P0",
      "color": "#E94444",
      "description": "기본 등급 설정, 비즈니스 핵심 기능을 사용할 수 없고 사용자에게 광범위한 영향을 미칩니다.",
      "uuid": "system_level_0",
      "isDefault": true,
      "isDisabled": false,
      "declaration": {}
    },
    {
      "name": "P1",
      "color": "#FF7931",
      "description": "기본 등급 설정, 비즈니스 핵심 기능을 사용할 수 없지만 영향받는 사용자가 제한적입니다(예: 내부 사용자에게만 영향).",
      "uuid": "system_level_1",
      "isDefault": true,
      "isDisabled": false,
      "declaration": {}
    },
    {
      "name": "P2",
      "color": "#FFB44A",
      "description": "기본 등급 설정, 비즈니스 부가 기능을 사용할 수 없으며 지속적인 장애는 사용자 경험에 광범위한 영향을 미칩니다.",
      "uuid": "system_level_2",
      "isDefault": true,
      "isDisabled": false,
      "declaration": {}
    },
    {
      "name": "알 수 없음",
      "color": "#C9C9C9",
      "description": "기본 등급 설정, 비즈니스 영향을 알 수 없습니다.",
      "uuid": "system_level_3",
      "isDefault": true,
      "isDisabled": false,
      "declaration": {}
    },
    {
      "id": 123,
      "uuid": "issl_example",
      "status": 0,
      "creator": "wsak_example",
      "updator": "",
      "createAt": 1785427200,
      "updateAt": -1,
      "deleteAt": -1,
      "workspaceUUID": "wksp_example",
      "name": "P3-경미",
      "color": "#3F94DC",
      "description": "일부 기능이 영향을 받음",
      "extend": {},
      "isManage": false,
      "declaration": {},
      "isDefault": false,
      "creatorInfo": {},
      "updatorInfo": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

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

문서 평가

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