삭제¶
POST /api/v1/notice/date/delete
개요¶
날짜 구성을 삭제합니다. 기본적으로 삭제되지 않은 알림 정책에서 참조되는지 먼저 확인합니다.
호출 전 및 사용 단계¶
먼저 사용자 지정 알림 날짜 목록에서 비어 있지 않은 대상 uuid 배열을 선택합니다. 기본 skipRefCheck=false: 관련 정책이 발견되면 HTTP200으로 refAlertPolicyNames 객체를 반환하고 날짜 구성을 유지하므로, 이때는 삭제 성공이 아닙니다. content=true인 경우에만 삭제 프로세스가 완료되었음을 의미합니다. 일치하는 날짜 기록을 찾지 못한 경우에도 true를 반환할 수 있습니다. 연관성 검사는 정책 구성 텍스트를 기준으로 매칭되므로, 안내된 이름은 정책 상세와 함께 확인해야 합니다. 빈 배열은 유효한 사전 점검 요청으로 간주되지 않으며, 대상과 무관한 연관성 안내가 반환될 수 있습니다. 알림 정책 상세에서 참조를 확인하고 조정하는 것을 우선하며, 강제 삭제가 꼭 필요한 경우에만 skipRefCheck=true를 명시적으로 지정합니다. 강제 삭제는 기존 alertOpt에서 UUID를 자동으로 제거하지 않고 해당 날짜 참조를 무효화하며 알림 정책 캐시를 정리합니다. 알림 윈도우가 더 이상 일치하지 않을 수 있으므로 정책 구성을 다시 확인해야 합니다.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>발급 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 발급받습니다. |
Body 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| noticeDatesUUIDs[*] | string | 단일 날짜 구성 UUID입니다. 예: ndate_example발급 또는 입력 방법: 사용자 지정 알림 날짜 목록의 단일 ndate_ UUID를 사용합니다. |
|
| noticeDatesUUIDs | array | Y | 삭제할 날짜 구성 UUID 배열이며 필수입니다. 날짜 텍스트를 입력하지 마십시오. null 허용: False 예: ["ndate_example"]발급 또는 입력 방법: 사용자 지정 알림 날짜 목록의 content.data[].uuid에서 대상을 가져옵니다. 비어 있지 않은 배열을 제출하십시오. |
| skipRefCheck | boolean | 선택 사항인 boolean이며, 기본값 false는 참조를 확인하고 true는 참조 확인을 건너뛰고 현재 워크스페이스에서 일치하는 구성을 삭제합니다. null 허용: False 예: false발급 또는 입력 방법: 일반 삭제 시에는 false를 사용하거나 생략하고, 연관 영향을 확인한 후에만 true를 사용합니다. |
매개변수 보충 설명¶
기본 연관성 안내는 성공 응답에 속하며 오류 코드가 아닙니다. 호출자는 HTTP200/success=true만 판단하지 말고 content 유형과 refAlertPolicyNames를 함께 확인해야 합니다. 삭제는 알림 정책 자체를 삭제하지 않습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/notice/date/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"noticeDatesUUIDs":["ndate_example"],"skipRefCheck":false}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object 또는 boolean | 참조가 있고 검사를 건너뛰지 않은 경우 객체이며, 삭제 프로세스가 완료되면 true입니다. |
| content.refAlertPolicyNames | array<string> |
연관성 검사 안내의 알림 정책 이름입니다. 이 필드가 있으면 이번에 삭제되지 않았음을 의미합니다. |
| content.refAlertPolicyNames[] | string | 단일 정책 이름입니다. |
| content.declaration | object 또는 null | 비어 있지 않은 객체 안내 분기에만 워크스페이스 공통 선언이 추가되며, true 분기에는 없습니다. |
{
"code": 200,
"content": {
"refAlertPolicyNames": [
"生产服务告警"
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
참조가 없거나 참조 검사를 명시적으로 건너뛰어 삭제 처리가 완료된 경우
{
"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 객체를 제출하십시오. |
| 500 | ft.InternalServerError | 연관성 검사, 삭제 또는 캐시 정리 실패 | 내부 오류 | 먼저 날짜 구성 및 참조 정책의 현재 상태를 확인하고, 지속적으로 실패하면 traceId를 제공하십시오. |