콘텐츠로 이동

삭제



POST /api/v1/alert_policy/delete

개요

현재 워크스페이스의 알림 정책을 일괄 삭제하고, 해당 모니터 및 보안 규칙 연결을 정리하며 캐시를 새로 고칩니다.

호출 전 및 사용 단계

알림 정책 목록에서 대상 UUID를 가져와 해당 알림 규칙이 더 이상 필요하지 않은지 확인한 후 제출합니다. 발견된 각 정책에 대해 사용자 지정 작업 권한을 검증하며, 일치하는 정책이 없으면 ObjectNotExists를 반환합니다. 정책 삭제는 모니터/SLO/보안 규칙 리소스 자체를 삭제하지 않습니다. 현재 명시적으로 정리되는 것은 일반 모니터와 보안 규칙 관계이며, SLO 관계가 자동으로 해제된다고 일괄적으로 가정할 수 없으므로 삭제 후 연결 화면에서 확인해야 합니다. 성공 시 true를 반환하며, 캐시 정리 및 일부 관계 캐시 업데이트에는 비동기 단계가 있습니다. 이미 처리 중인 알림이 취소된다는 보장은 없습니다. 저장 및 캐시 새로 고침은 알림 전달을 의미하지 않으며, 실제 전송은 유효한 대상, 이벤트 등급, 시간대, 필터, 중복 억제 및 알림 실행 서비스에 따라 달라집니다. 실패하거나 시간 초과된 후에는 먼저 정책 및 바인딩 상태를 읽어 중복 생성이나 부분 업데이트 오판을 피해야 합니다.

요청 헤더

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

Body 요청 파라미터

파라미터 이름 유형 필수 설명
alertPolicyUUIDs[*] string 단일 altpl_ 알림 정책 UUID입니다.
예시: altpl_example
획득 또는 입력 방법: 알림 정책 목록에서 정책 UUID 하나를 복사합니다.
alertPolicyUUIDs array Y 삭제할 정책 UUID 배열이며 필수입니다. 비어 있지 않은 배열을 제출하는 것이 좋습니다. 현재 워크스페이스의 삭제되지 않은 정책만 처리합니다.
null 허용: False
예시: ["altpl_example"]
획득 또는 입력 방법: 알림 정책 목록의 content.data[].uuid에서 동일 워크스페이스의 대상 UUID를 가져옵니다.

파라미터 추가 설명

일괄 처리 중 존재하지 않는 개별 UUID에 대해 항목별 오류가 반환된다는 보장은 없습니다. 최종 결과는 목록 및 연결 정보를 다시 읽어 확인해야 합니다.

요청 예시

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

응답

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

필드 유형 설명
content boolean 삭제 처리가 성공하면 true입니다. UUID별 결과는 제공하지 않습니다.
{
  "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 파일 형식 오류 단일 JSON 객체를 제출하십시오.
404 ft.ObjectNotExists 현재 워크스페이스에서 일치하는 삭제되지 않은 정책을 찾을 수 없음(빈 배열 포함) 지정한 객체가 존재하지 않음 UUID와 워크스페이스를 다시 확인하십시오.
403 ft.ForbiddenAlertPolicyOperation 일부 정책은 현재 자격 증명으로 작업할 수 없음 알림 정책 【{}】 작업 권한이 없습니다 먼저 해당 정책에 대한 작업 권한을 획득하십시오.
403 ft.Forbidden 현재 자격 증명에 인터페이스 작업 권한이 없음 작업 권한이 없습니다 삭제 권한이 있는 API Key를 사용하십시오.
500 ft.InternalServerError 관계, 캐시 또는 기타 삭제 처리 실패 내부 오류 먼저 정책 및 관계 상태를 확인한 후 재시도 여부를 결정하십시오. 지속적으로 실패하면 traceId를 제공하십시오.

문서 평가

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