콘텐츠로 이동

기본 구성 상태 수정



POST /api/v1/incidents/level/config/set

개요

현재 워크스페이스의 기본 인시던트 등급을 활성화하거나 비활성화합니다.

호출 전 및 사용 단계

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

isDisabled 불리언을 반드시 전달해야 하며, true이면 기본 4개 등급을 비활성화하고 false이면 활성화합니다. 기본 항목을 삭제하지 않고, 워크스페이스 사용자 정의 등급 저장에 영향을 주지 않으며, 기존 인시던트/Issue/모니터 참조도 수정하지 않습니다. 현재 '사용 가능한 사용자 정의 등급이 최소 하나 이상이어야 함/기본 등급 참조가 남아 있으면 비활성화할 수 없음' 보호 기능이 활성화되어 있지 않으므로, 비활성화하기 전에 적절한 등급을 먼저 생성하고 마이그레이션하여 사용 가능한 선택지를 잃지 않도록 하십시오. 반복 설정 시 구성이 기록되고 활성화/비활성화 감사 로그가 남는데, 부작용이 없음을 보장하지는 않습니다.

응답은 config_get과 다릅니다. 이 페이지는 구성 데이터베이스 엔터티를 반환하며 목표 값은 content.config.isDisabled에 있고, 조회 페이지는 content.isDisabled를 반환합니다. 타임아웃/실패 시 먼저 config_get으로 목표 값이 저장되었는지 확인한 후 재시도 여부를 결정하십시오.

요청 헤더

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

Body 요청 파라미터

파라미터명 유형 필수 설명
isDisabled bool Y 필수 boolean, true 비활성화/false 활성화. 생략/null/문자열 불가. 기본 등급을 삭제하거나 참조를 마이그레이션하지 않습니다.
null 허용: False
예: true
획득 또는 입력 방법: 워크스페이스 관리자가 기본 4개 등급을 계속 등급 선택에 참여시킬지 확인합니다.

요청 예시

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

응답

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

필드 유형 설명
content.id integer 또는 null 데이터베이스 행 ID. 비즈니스 위치 지정에는 uuid를 사용하며, 제출 전 스냅샷에서는 null일 수 있습니다.
content.uuid string 해당 리소스 UUID입니다.
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 현재 워크스페이스 UUID입니다.
content.keyCode string 고정 값 IssueLevelDisabled, Issue 등급과 공유됩니다.
content.config object 저장된 스위치 객체입니다.
content.config.isDisabled boolean 저장된 목표 값. true이면 기본 4개 등급을 비활성화하고 false이면 활성화합니다.
content.declaration object 현재 워크스페이스의 공통 선언입니다.
{
  "code": 200,
  "content": {
    "id": 123,
    "uuid": "ctcf_example",
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "workspaceUUID": "wksp_example",
    "keyCode": "IssueLevelDisabled",
    "config": {
      "isDisabled": 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 파일 형식 오류 isDisabled 불리언을 포함한 객체를 제출하십시오.
500 ft.InternalServerError 데이터베이스, 구성/ID 형식 또는 처리되지 않은 시스템 예외 내부 오류 읽기는 백오프 재도를 허용하며, 쓰기는 먼저 구성/등급 목록을 다시 읽어 저장 여부를 확인한 후 재시도 여부를 결정하십시오.

문서 평가

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