삭제¶
POST /api/v1/aggs_to_metric/delete
개요¶
생성된 메트릭 규칙을 일괄 소프트 삭제하고, 해당 주기 스케줄 및 리소스 관계를 정리합니다.
호출 전 및 사용 단계¶
먼저 각 대상 UUID를 확인하고, 현재 워크스페이스의 삭제되지 않은 규칙만 조작합니다. 요청 배열에 아무 것도 매칭되지 않으면(빈 배열 [] 포함) ObjectNotExists가 발생하며, 일부 UUID가 매칭되지 않아도 항목별 오류는 반환되지 않습니다. 성공 시 true를 반환하고, 규칙은 삭제 상태로 설정되며, 해당 스케줄과 리소스 연결이 정리되지만, 이미 생성된 과거 메트릭 데이터는 삭제하지 않습니다.
이 진입점들은 공통 규칙 처리를 공유하며, 일부 대상 조회에는 type=aggs 조건이 추가로 제한되지 않습니다. 따라서 본 모듈 목록에서 반환된 UUID만 사용하여 다른 규칙을 잘못 읽거나 변경하는 일을 피하세요.
스케줄 삭제와 데이터베이스 소프트 삭제, 연결 정리는 단계적으로 수행되므로, 오류 발생 시 스케줄은 이미 삭제되었거나 규칙은 이미 저장되었을 수 있습니다. 재시도 여부를 결정하기 전에 먼저 규칙과 관계 상태를 조회하세요. 이미 실행이 시작된 작업은 삭제로 인해 즉시 종료된다고 보장되지 않습니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| ruleUUIDs[*] | string | 단일 전체 UUID이며, 공백이 자동으로 제거되지 않습니다. 예시: rul_aggs_example획득 또는 입력 방법: 생성 메트릭 규칙 목록에서 단일 aggs 규칙 uuid를 가져옵니다. |
|
| ruleUUIDs | array | Y | 필수 문자열 배열이며, 비어 있지 않을 것을 권장하고 쉼표로 구분된 문자열이 아닙니다. 본 모듈 목록의 aggs UUID만 사용하고, 동일한 rul_ 접두사로 타입을 판단하지 마세요.null 허용: False 예시: ["rul_aggs_example"]획득 또는 입력 방법: 생성 메트릭 규칙 목록에서 각 규칙 UUID를 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/aggs_to_metric/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"ruleUUIDs":["rul_aggs_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 파일 형식 오류 | 예시에 따라 JSON 객체를 제출하세요. |
| 404 | ft.ObjectNotExists | 현재 워크스페이스에 요청 UUID에 대응하는 삭제되지 않은 규칙이 없음(빈 배열 [] 포함) |
지정된 객체가 존재하지 않음 | 본 모듈 목록에서 유효한 규칙 UUID를 가져오세요. |
| 403 | ft.Forbidden | 현재 신원에 삭제/리소스 작업 권한이 없음 | 작업 권한이 없습니다 | 해당 작업 권한이 있는 API Key를 사용하세요. |
| 400 | ft.OuterFuncFailed | 하위 스케줄 삭제가 실패를 반환함 | 외부 함수 호출 실패 | 먼저 스케줄과 규칙 상태를 확인하고, 지속적으로 실패하면 traceId를 제공하세요. |
| 500 | ft.InternalServerError | 하위 타임아웃/일반 5xx, 데이터베이스 또는 후속 메타데이터 처리 실패 | 내부 오류 | 먼저 규칙과 그 상태, 출력 메트릭 및 스케줄 현황을 읽은 후 재시도 여부를 결정하고, traceId를 제공하세요. |