콘텐츠로 이동

사용자 정의 등급 삭제



POST /api/v1/incidents/level/delete

개요

현재 워크스페이스의 사용자 정의 인시던트 등급을 일괄 삭제합니다.

호출 전 준비 및 사용 단계

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

uuids는 필수 배열이며, []인 경우 즉시 true로 성공합니다. 항목 중 하나라도 system_level_로 시작하면 전체 배치가 거부되며, 그 외의 경우에는 이 워크스페이스에서 삭제되지 않은 일치 항목만 삭제됩니다. 알 수 없거나 다른 워크스페이스에 속하거나 이미 삭제된 UUID는 조용히 무시되고, 삭제 수량이나 항목별 결과는 반환되지 않으므로 true가 각 항목의 존재를 의미하지 않습니다.

이는 등급 설정의 소프트 삭제이며, 인시던트/Issue를 삭제하거나 해당 과거 level 값을 비우지 않고, 모니터/인시던트/에스컬레이션 설정의 참조도 자동으로 이전하지 않습니다. 현재 "아직 사용 중이므로 삭제 불가" 또는 "최소 하나의 사용자 정의 등급 유지"와 같은 런타임 보호는 없으며, 기본 등급을 비활성화한 후에도 모든 사용자 정의 항목을 삭제할 수 있습니다. 삭제 전에 참조를 먼저 파악하고 조정하여 필요한 등급을 유지하고, 삭제 후에는 등급 목록과 비즈니스 표시를 확인하세요. 실패 시 먼저 현재 상태를 다시 읽은 후 재시도하며, 500 응답만으로 삭제되지 않았다고 판단해서는 안 됩니다.

요청 헤더

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

Body 요청 파라미터

파라미터명 유형 필수 설명
uuids[*] string 단일 사용자 정의 등급 UUID 문자열이며 system_level_ 접두사를 사용할 수 없습니다.
예: issl_example
획득 또는 입력 방법: uuids와 동일한 출처입니다.
uuids array Y 필수 배열입니다. []는 작업 없이 true입니다. 이 워크스페이스에서 일치하는 사용자 정의 항목만 삭제하며 수량을 반환하지 않고, 기본 등급 접두사가 포함되면 전체 배치가 거부됩니다.
null 허용: False
예: ["issl_example"]
획득 또는 입력 방법: 인시던트 등급 목록에서 isDefault=false인 uuid를 가져오고, 먼저 참조를 파악합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/incidents/level/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"uuids":["issl_example"]}'

응답

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 최상위가 객체가 아님 일부 json 파일 형식 오류 uuids 배열 객체를 제출합니다.
406 ft.NotAllowDeleteDefaultIssueLevel uuids에 system_level_ 접두사 값이 포함됨 워크스페이스 기본 등급 설정 정보는 삭제할 수 없습니다 기본 등급은 config_set으로 활성화/비활성화하며 삭제할 수 없습니다. 사용자 정의 항목은 목록에서 필터링합니다.
500 ft.InternalServerError 데이터베이스, 설정/ID 형식 또는 처리되지 않은 시스템 예외 내부 오류 읽기는 백오프 재시도를 수행할 수 있으며, 쓰기는 먼저 설정/등급 목록을 다시 읽어 저장 여부를 확인한 후 재시도 여부를 결정합니다.

문서 평가

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