콘텐츠로 이동

삭제



POST /api/v1/incidents/schedule/delete

개요

인시던트 온콜 및 해당 이력 구성을 일괄 소프트 삭제합니다.

호출 전 및 사용 단계

현재 Key에는 incidents.incidentsSchedule 권한이 필요합니다. 현재 워크스페이스에서 삭제되지 않은 일치 일정만 대상으로 하며, 알 수 없거나 다른 워크스페이스에 속하거나 이미 삭제된 항목은 무시됩니다. []에 대상이 없어도 true를 반환하며, 항목별 결과는 제공하지 않습니다. 일치하는 기본 일정 중 isDefault=true가 있으면 400으로 거부됩니다. 먼저 기본 항목을 확인해야 하며, 일괄 요청을 기본 항목 자동 건너뛰기로 간주해서는 안 됩니다.

일치한 온콜 일정과 해당 이력 업데이트 기록을 소프트 삭제하며, 기존 인시던트, 알림 대상, 팀 또는 멤버는 삭제하지 않습니다. 이 메서드는 임시 대체 온콜 엔터티를 함께 정리하지 않으므로, 성공 응답만으로 모든 대체 온콜 데이터가 물리 삭제되었다고 주장할 수 없습니다. 제출 후 인시던트 매칭 큐에서 제거하는 작업을 항목별로 전달합니다. 전달 실패 시 500이 발생할 수 있으며 이미 소프트 삭제된 상태이므로, 먼저 목록에서 확인한 후 재시도하십시오. 삭제 후에는 이 공개 복구 인터페이스가 없으므로 구성을 미리 백업하십시오. 재생성 시 새 UUID가 생성되며, 이미 전송된 알림은 회수되지 않습니다.

요청 헤더

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

Body 요청 매개변수

매개변수 이름 유형 필수 설명
scheduleUUIDs[*] string 하나의 온콜 일정 UUID 문자열이며, 정책/인시던트/대체 온콜 UUID가 아닙니다. 하위 항목의 유효성은 개별적으로 검증되지 않습니다.
예: incsch_example
획득 또는 입력 방법: 온콜 목록의 일반 관리 모드에서 content.data[].uuid의 incsch_ UUID를 획득합니다.
scheduleUUIDs array Y 필수 UUID 배열이며, []이면 일치 항목이 없습니다. 현재 워크스페이스에서 삭제되지 않은 일치 항목만 대상으로 하며, 기본 일정은 삭제할 수 없습니다.
null 허용: False
예: ["incsch_example"]
획득 또는 입력 방법: 온콜 목록의 일반 관리 모드에서 content.data[].uuid의 incsch_ UUID를 획득합니다.

매개변수 추가 설명

요청은 이 페이지에 공개된 매개변수를 기준으로 합니다. 하루 내 start/end는 HH:MM이며, 유효 기간과 대체 온콜 시간은 Unix 초 단위입니다. 전체 필드, 값 출처, 응답 분기 및 실패 처리는 아래를 참조하십시오.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/incidents/schedule/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"scheduleUUIDs":["incsch_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 파일 형식 오류 scheduleUUIDs 배열 객체를 제출하십시오.
400 ft.DefaultIncidentScheduleCannotDelete 일치 항목에 isDefault=true인 기본 일정이 포함되어 있습니다. 기본 인시던트 온콜은 삭제할 수 없습니다. 기본 일정을 제외하고 먼저 목록을 확인하십시오. 기본 구성을 강제로 삭제할 수 없습니다.
500 ft.InternalServerError 데이터베이스/태그 잠금 캐시, 알림 하위 구조, 잘못된 시간대 또는 제출 후 큐 전달 등 처리되지 않은 예외 내부 오류 먼저 온콜 일정/태그의 실제 상태를 다시 조회하십시오. 주요 데이터는 이미 커밋되었을 수 있으며, 큐가 수렴되지 않았더라도 중복 생성해서는 안 됩니다. traceId를 보관하여 처리하고, 수정 전에 전체 구성을 백업하십시오.

문서 평가

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