생성¶
POST /api/v1/slo/add
개요¶
모니터 유형 또는 메트릭 유형 SLO 및 해당 감지 설정을 생성합니다.
호출 전 및 사용 단계¶
현재 API Key에는 monitor.sloCfgManage 권한이 필요합니다. 메트릭 유형 저장에는 대상 메트릭 namespace 조회 권한도 필요하며, SLO 관리 권한만으로는 이 사전 검사를 통과할 수 없습니다. Key가 속한 워크스페이스에서만 작업합니다. 경로의 SLO UUID는 SLO 목록 가져오기의 content.data[].uuid(일반적으로 monitor_ 접두사)를 사용하며, 연결된 모니터의 Rule UUID 또는 metricQueryInfo.sloId가 아닙니다.
메트릭 유형은 good/total로 가용성을 계산하며, 비즈니스 백분율을 카운트로 직접 혼용해서는 안 됩니다. DQL은 각각 비교 가능한 단일 숫자 값으로 집계되어야 하며, 실제 데이터와 권한을 먼저 검증해야 합니다. PromQL은 sum(...) 등의 집계를 사용할 수 있으며, 이 API는 promqlType을 일괄 즉시 쿼리로 처리합니다. 모니터 유형은 SLI 모니터를 참조하여 감점을 계산하고 SLO 결과를 생성합니다. groupBy를 구성하면 project/env/service 차원으로 각각 계산합니다. 알림 정책을 구성하지 않으면 해당 정책의 알림 연결이 없으며, 저장에 성공하더라도 알림이 전송되었음을 보장하지 않습니다.
생성, 수정 및 활성화/비활성화는 로컬 트랜잭션 마지막에 커밋되며, 실패하면 원격 스케줄과 캐시 복구를 시도합니다. 원격 보상도 실패할 수 있으므로 HTTP 실패만으로 모든 시스템에 변경이 없다고 판단할 수 없습니다. 네트워크 타임아웃/500 이후에는 먼저 SLO 상세 가져오기로 구성과 상태를 확인하고, 필요한 경우 관리자에게 스케줄을 확인한 후 재시도하세요. 저장 성공이 감지 결과가 이미 생성되었음을 의미하지 않으므로 감지 주기를 기다린 후 실제 데이터를 확인해야 합니다. 생성은 멱등적이지 않습니다. 중복 이름은 거부되지만 요청 결과를 알 수 없을 때는 먼저 이름으로 검색해야 합니다. 생성 응답에는 전체 tagInfo 또는 alertPolicyInfos가 포함되지 않으므로 저장 후 상세를 읽어 연결을 확인합니다.
metricResultValidAfter/metricResultStoppedAt/metricQueryInfo 등 서버 전용 필드를 제출하지 마세요. 공개되지 않은 Body 필드는 라우트 선언에서 먼저 공통 406 파라미터 오류로 거부됩니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| metricQueries.total | object | 총량 조회 객체입니다. dql이 반드시 있어야 하며 editor만 제공할 수 없습니다. 예시: {"dql": "M::http_requests:(SUM(`total`))"}가져오기 또는 입력 방법: 대상 메저먼트와 해당 비즈니스 필드로 구성합니다. |
|
| metricQueries.total.dql | string | 필수 비어 있지 않은 쿼리 문자열이며 최대 65536자입니다. queryType=dql일 때는 현재 워크스페이스 M 메트릭의 단일 출력 SELECT 또는 유효한 eval 표현식만 지원하며, SHOW/기타 실행 함수, 크로스 워크스페이스 메트릭 또는 DQL 자체 윈도는 지원하지 않습니다. 호출자는 먼저 비교 가능한 단일 숫자 값으로 집계하고 결과를 검증하여 GROUP BY로 인한 다중 시계열 생성을 피해야 합니다. queryType=promql일 때 이 필드의 이름은 여전히 dql이며 유효한 PromQL을 입력합니다. 예시: M::http_requests:(SUM(`total`))가져오기 또는 입력 방법: 해당 메트릭 쿼리의 언어와 비즈니스 필드로 결정합니다. |
|
| metricQueries.total.queryType | string | 선택 가능한 값은 dql/promql이며 기본값은 dql입니다. dql 문자열의 구문 분석 및 실행 언어를 결정합니다. 예시: dql가져오기 또는 입력 방법: 해당 메트릭 쿼리의 언어와 비즈니스 필드로 결정합니다. |
|
| metricQueries.total.promqlType | string | queryType=promql일 때만 나타날 수 있습니다. instantQuery/rangeQuery를 입력하지만 실제 저장 및 실행은 일괄 instantQuery로 처리되며, rangeQuery를 전달했다고 해서 범위 결과를 요구할 수 없습니다. DQL 분기에 이 키가 나타나면 거부됩니다. 예시: instantQuery가져오기 또는 입력 방법: 해당 메트릭 쿼리의 언어와 비즈니스 필드로 결정합니다. |
|
| metricQueries.total.editor | object | 선택적 에코 객체이며 기본값은 {}입니다. 편집기 상태를 저장하며 실행 쿼리 비교에는 참여하지 않고, 수정 시 쿼리 객체가 전체 교체됩니다. 예시: {}가져오기 또는 입력 방법: 해당 메트릭 쿼리의 언어와 비즈니스 필드로 결정합니다. |
|
| metricQueries.good | object | 성공량 조회 객체입니다. dql이 반드시 있어야 하며 editor만 제공할 수 없습니다. 예시: {"dql": "M::http_requests:(SUM(`good`))"}가져오기 또는 입력 방법: 대상 메저먼트와 해당 비즈니스 필드로 구성합니다. |
|
| metricQueries.good.dql | string | 필수 비어 있지 않은 쿼리 문자열이며 최대 65536자입니다. queryType=dql일 때는 현재 워크스페이스 M 메트릭의 단일 출력 SELECT 또는 유효한 eval 표현식만 지원하며, SHOW/기타 실행 함수, 크로스 워크스페이스 메트릭 또는 DQL 자체 윈도는 지원하지 않습니다. 호출자는 먼저 비교 가능한 단일 숫자 값으로 집계하고 결과를 검증하여 GROUP BY로 인한 다중 시계열 생성을 피해야 합니다. queryType=promql일 때 이 필드의 이름은 여전히 dql이며 유효한 PromQL을 입력합니다. 예시: M::http_requests:(SUM(`good`))가져오기 또는 입력 방법: 해당 메트릭 쿼리의 언어와 비즈니스 필드로 결정합니다. |
|
| metricQueries.good.queryType | string | 선택 가능한 값은 dql/promql이며 기본값은 dql입니다. dql 문자열의 구문 분석 및 실행 언어를 결정합니다. 예시: dql가져오기 또는 입력 방법: 해당 메트릭 쿼리의 언어와 비즈니스 필드로 결정합니다. |
|
| metricQueries.good.promqlType | string | queryType=promql일 때만 나타날 수 있습니다. instantQuery/rangeQuery를 입력하지만 실제 저장 및 실행은 일괄 instantQuery로 처리되며, rangeQuery를 전달했다고 해서 범위 결과를 요구할 수 없습니다. DQL 분기에 이 키가 나타나면 거부됩니다. 예시: instantQuery가져오기 또는 입력 방법: 해당 메트릭 쿼리의 언어와 비즈니스 필드로 결정합니다. |
|
| metricQueries.good.editor | object | 선택적 에코 객체이며 기본값은 {}입니다. 편집기 상태를 저장하며 실행 쿼리 비교에는 참여하지 않고, 수정 시 쿼리 객체가 전체 교체됩니다. 예시: {}가져오기 또는 입력 방법: 해당 메트릭 쿼리의 언어와 비즈니스 필드로 결정합니다. |
|
| sliUUIDs[*] | string | 단일 문자열 항목입니다. 배열에는 객체/배열/null이 포함되어서는 안 됩니다. 예시: rul_example가져오기 또는 입력 방법: 모니터 목록에서 content.data[].uuid를 가져오며 search로 이름을 검색할 수 있습니다. 동일 워크스페이스에 있고 삭제되지 않았으며 SLI로 사용할 수 있는 모니터인지 확인해야 합니다. |
|
| alertPolicyUUIDs[*] | string | 단일 문자열 항목입니다. 배열에는 객체/배열/null이 포함되어서는 안 됩니다. 예시: altpl_example가져오기 또는 입력 방법: 알림 정책 목록에서 현재 워크스페이스의 유효한 정책 uuid를 가져옵니다. |
|
| tags[*] | string | 단일 문자열 항목입니다. 배열에는 객체/배열/null이 포함되어서는 안 됩니다. 예시: production가져오기 또는 입력 방법: 태그 목록에서 scope에 monitor 또는 all이 포함된 태그 이름을 선택합니다. 새 이름을 전달할 수도 있습니다. |
|
| groupBy[*] | string | 단일 문자열 항목입니다. 배열에는 객체/배열/null이 포함되어서는 안 됩니다. project/env/service만 가능합니다. 예시: service가져오기 또는 입력 방법: 수집된 project/env/service 차원을 선택하며, 원본 모니터 이벤트/서비스 데이터에 해당 필드가 있는지 확인해야 합니다. |
|
| alertPolicyUUIDs | array | 선택적 배열입니다. 생성 시 생략하면 연결하지 않고, 수정 시 생략하면 유지하며 []이면 모든 연결을 해제합니다. 전달 시 전체 교체 및 중복 제거되며, 알 수 없거나 삭제되었거나 다른 워크스페이스의 정책은 거부됩니다. 이 API를 통해 알림 대상 또는 alertOpt를 직접 구성하지 않습니다. null 허용: False 예시: ["altpl_example"]가져오기 또는 입력 방법: 알림 정책 목록에서 현재 워크스페이스의 유효한 정책 uuid를 가져옵니다. |
|
| checkRange | integer | 집계 윈도 초 수이며 604800/2592000만 가능합니다. 생성 시 생략하면 604800이고, 수정 시 생략하면 유지됩니다. 기존 90일 등 이전 구성은 지원되는 값으로 명시적으로 변경해야 저장할 수 있습니다. null 허용: False 선택 가능한 값: [604800, 2592000] 예시: 604800가져오기 또는 입력 방법: SLO 집계 요구 사항에 따라 7일 또는 30일을 선택합니다. |
|
| describe | string | 선택적 문자열이며 최대 3000자입니다. 생성 시 생략하면 빈 문자열이고, 수정 시 생략하면 유지되며, 빈 문자열이면 지웁니다. null은 허용되지 않습니다. 빈 문자열 허용: True null 허용: False 최대 길이: 3000 예시: 결제 서비스 프로덕션 환경 SLO가져오기 또는 입력 방법: 호출자가 용도/유지보수 설명을 입력합니다. |
|
| goal | float | Y | 생성 시 필수 숫자이며 0<goal<100입니다. 수정 시에는 생략하거나 원래 값만 전달할 수 있습니다. 예: 99.9는 0.999가 아닌 99.9%를 의미합니다. null 허용: False 0보다 큼 100보다 작음 예시: 99.9가져오기 또는 입력 방법: 비즈니스 SLA에 따라 예상 목표를 정하며 단위는 백분율입니다. |
| groupBy | array | 모니터 유형에서만 지원합니다. 배열 내에는 project/env/service만 허용되며 중복될 수 없고 순서는 유지됩니다. 생성 시 기본값은 []이고, 수정 시 생략하면 유지되며 []이면 그룹화를 취소합니다. 메트릭 유형은 생략하거나 []을 사용합니다. null 허용: False 예시: ["service"]가져오기 또는 입력 방법: 수집된 project/env/service 차원을 선택하며, 원본 모니터 이벤트/서비스 데이터에 해당 필드가 있는지 확인해야 합니다. |
|
| ignoreBadGroupEvents | boolean | 모니터 유형에서만 전달할 수 있으며 기본값은 true입니다. groupBy가 비어 있지 않을 때만 저장되고 계산에 참여합니다. 수정 시 생략하면 유지되며, 그룹을 새로 추가하고 원래 값이 없으면 true입니다. groupBy를 취소하면 이 구성이 제거됩니다. 메트릭 유형은 false를 전달해도 거부됩니다. null 허용: False 예시: true가져오기 또는 입력 방법: groupBy가 있을 때 비정상 그룹 이벤트를 무시할지 여부에 따라 선택합니다. |
|
| interval | string | Y | 생성 시 필수이며 값은 5m 또는 10m입니다. 수정 시 생략하면 유지됩니다. checkRange 집계 윈도와는 같은 개념이 아닙니다. null 허용: False 선택 가능한 값: ['5m', '10m'] 예시: 5m가져오기 또는 입력 방법: 필요에 따라 감지 주기를 선택합니다. |
| metricQueries | object | 메트릭 유형에서만 사용합니다. 생성 시 필수이고, 수정 시 생략하면 유지되며, 나타나면 total/good 전체 그룹이 교체되고 부분 patch 또는 null은 허용되지 않습니다. 객체는 정확히 total과 good을 포함합니다. 각 항목은 dql/queryType/editor 및 PromQL의 promqlType을 지원하며 다른 실행 옵션은 허용되지 않습니다. 두 항목은 동일한 비즈니스 범위/시간 단위의 총량과 성공량을 측정하여 비교 가능해야 하며, API 저장은 고객의 비즈니스 정확성을 대신 검증하지 않습니다. null 허용: False 예시: {"total": {"dql": "M::http_requests:(SUM(`total`))"}, "good": {"dql": "M::http_requests:(SUM(`good`))"}}가져오기 또는 입력 방법: 메트릭 데이터에서 총량과 성공량 필드를 결정하고, 먼저 데이터 쿼리로 각 쿼리 값과 수집 범위를 검증합니다. |
|
| minGoal | float | Y | 생성 시 필수 숫자이며 0<minGoal<goal<100입니다. 수정 시에는 생략하거나 원래 값만 전달할 수 있습니다. minGoal 미만은 critical, minGoal 이상이지만 goal 미만은 warning입니다. null 허용: False 0보다 큼 100보다 작음 예시: 99.5가져오기 또는 입력 방법: 최소 허용 가용성에 따라 정하며 단위는 백분율입니다. |
| name | string | Y | 생성 시 필수 문자열이며 최대 256자이고, 동일 워크스페이스의 활성 SLO와 이름이 중복될 수 없습니다. 호출자는 비어 있지 않은 이름을 사용해야 합니다. 수정 시 생략할 수 있으며, 제출 시 원래 이름과 정확히 일치해야 합니다. null 허용: False 최대 길이: 256 예시: 결제 서비스 가용성가져오기 또는 입력 방법: 호출자가 SLO에 이름을 지정하며, 수정 전에 먼저 상세를 읽습니다. |
| sliType | string | 생성 시 기본값은 monitor이며 monitor/metric을 선택할 수 있습니다. 생성 후에는 전환할 수 없고, 수정 시 생략하면 유지되며 전달 값은 원래 값만 허용됩니다. null 허용: False 선택 가능한 값: ['monitor', 'metric'] 예시: monitor가져오기 또는 입력 방법: 기존 모니터 계산 또는 메트릭 쿼리 계산을 선택합니다. |
|
| sliUUIDs | array | 모니터 유형 생성 시 반드시 비어 있지 않아야 합니다. 수정 시 생략하면 참조를 유지하고 []이면 참조를 비웁니다(SLO에 유효한 SLI가 없어질 수 있으므로 먼저 확인하세요). 전체 교체 및 중복 제거되며 순서는 보장되지 않습니다. 메트릭 유형은 생략하거나 []을 사용하며 비어 있지 않을 수 없습니다. 동일 워크스페이스의 활성 type=trigger 또는 기존 빈 type 규칙만 SLI로 사용합니다. 현재 저장은 유효하지 않거나 다른 워크스페이스의 UUID를 항목별로 거부하지 않으므로 성공이 각 항목의 계산 가능성을 증명하지 않습니다. null은 허용되지 않습니다. null 허용: False 예시: ["rul_example"]가져오기 또는 입력 방법: 모니터 목록에서 content.data[].uuid를 가져오며 search로 이름을 검색할 수 있습니다. 동일 워크스페이스에 있고 삭제되지 않았으며 SLI로 사용할 수 있는 모니터인지 확인해야 합니다. |
|
| status | integer | 선택 가능한 값은 0 활성화/2 비활성화입니다. 생성 시 기본값은 0이고, 수정 시 생략하면 유지됩니다. null은 허용되지 않습니다. null 허용: False 선택 가능한 값: [0, 2] 예시: 0가져오기 또는 입력 방법: 즉시 감지를 시작할지 여부에 따라 선택합니다. |
|
| tags | array | 이름 배열이며 각 항목은 최대 128자이고 대소문자를 구분합니다. 새 이름은 monitor 스코프로 생성됩니다. 생성 시 생략하면 태그가 없고, 수정 시 생략하면 유지되며 []이면 지웁니다. 전체 교체 및 중복 제거됩니다. 동일 이름의 기존 태그가 monitor를 지원하지 않으면 400이며 null은 허용되지 않습니다. null 허용: False 예시: ["production"]가져오기 또는 입력 방법: 태그 목록에서 scope에 monitor 또는 all이 포함된 태그 이름을 선택합니다. 새 이름을 전달할 수도 있습니다. |
파라미터 추가 설명¶
SLI UUID는 모니터 목록의 Rule uuid를 사용합니다. 알림은 alertPolicyUUIDs를 통해 알림 정책과 연결되고, 이후 정책이 알림을 제어합니다. 이전 문서의 alertOpt/alertTarget을 제출하지 마세요. 이 진입점은 해당 필드를 공개하지 않습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/slo/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"결제 서비스 가용성","interval":"5m","goal":99.9,"minGoal":99.5,"sliUUIDs":["rul_example"]}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 데이터베이스 행 ID입니다. 생성 응답은 커밋 전에 생성되므로 null일 수 있습니다. 비즈니스 식별자로는 uuid를 사용합니다. |
| content.uuid | string | SLO UUID이며 이후 상세, 수정, 활성화/비활성화, 삭제에 사용합니다. |
| content.workspaceUUID | string | 대상 워크스페이스 UUID입니다. |
| content.name | string | SLO 이름입니다. |
| content.type | string | 고정 값 slo입니다. |
| content.score | integer | 리소스 정렬 가중치이며 SLO 가용성 백분율이 아닙니다. |
| content.status | integer | 0 활성화/2 비활성화입니다. |
| content.creator | string | 생성 Key 리소스 UUID 또는 이전 계정 식별자입니다. |
| content.updator | string | 최근 업데이트 주체이며 생성 시 비어 있을 수 있습니다. |
| content.createAt | integer | 생성 시간, Unix 초입니다. |
| content.updateAt | integer | 최근 업데이트 시간, Unix 초입니다. 업데이트되지 않은 경우 -1일 수 있습니다. |
| content.deleteAt | integer | 삭제 시간이며 정상 활성 레코드는 -1입니다. |
| content.config | object | 저장된 SLO 계산 구성입니다. 직접 알림 대상 구성 alertOpt는 포함하지 않습니다. |
| content.config.sliType | string | monitor 또는 metric이며, 이전 구성에서 누락되면 monitor로 반환됩니다. |
| content.config.checkRange | integer | 집계 윈도 초 수이며 604800 또는 2592000입니다. |
| content.config.goal | number | 예상 목표 백분율입니다. |
| content.config.minGoal | number | 최소 목표 백분율입니다. |
| content.config.interval | string | 5m 또는 10m입니다. |
| content.config.describe | string | 용도 설명입니다. |
| content.config.groupBy | array<string> |
모니터 유형 그룹화 차원 배열이며 메트릭 유형은 비어 있습니다. |
| content.config.groupBy[] | string | project/env/service 중 하나입니다. |
| content.config.ignoreBadGroupEvents | boolean | 그룹화 차원이 존재할 때만 반환됩니다. 비정상 그룹 이벤트를 무시할지 여부입니다. |
| content.config.sli_infos | array<object> 또는 object |
이번 로드에서 SLI 요약을 로드한 경우 존재합니다. 모니터 유형은 일반적으로 객체 배열이고, 메트릭 유형 생성 시 현재 {}입니다. 수정에서 sliUUIDs를 제출하지 않으면 생략될 수 있습니다. 이 필드를 전체 참조 UUID 목록으로 간주해서는 안 됩니다. |
| content.config.sli_infos[].id | string | 실제로 현재 워크스페이스의 유효한 SLI 모니터에 매칭된 Rule UUID입니다. |
| content.config.sli_infos[].name | string 또는 null | SLI 모니터 이름입니다. |
| content.config.sli_infos[].status | integer | 연결된 모니터 상태이며 0 또는 2일 수 있습니다. 존재하지 않는 참조는 요약에 포함되지 않습니다. |
| content.config.metricResultValidAfter | integer 또는 null | 메트릭 유형 전용: 이번 집계의 적용 하한, Unix 밀리초입니다. 생성, 윈도 변경/쿼리 실행, 비활성화에서 활성화로 전환 시 재설정됩니다. editor만 변경하면 재설정되지 않습니다. |
| content.config.metricResultStoppedAt | integer 또는 null | 메트릭 유형 전용: 계산 중지 시간 Unix 밀리초입니다. 실행 중에는 null이고 비활성화 시 기록됩니다. |
| content.metricQueryInfo | object | 메트릭 유형 전용: 쿼리 결과 위치 정보이며 원본 비즈니스 메트릭 값이 아닙니다. |
| content.metricQueryInfo.measurement | string | 고정 값 slo_metric입니다. |
| content.metricQueryInfo.sloId | string | 실제 감지 Rule UUID이며 slo_metric.slo_id 조회에 사용합니다. content.uuid와 다릅니다. |
| content.metricQueryInfo.validAfter | integer 또는 null | config.metricResultValidAfter와 같습니다. |
| content.metricQueryInfo.stoppedAt | integer 또는 null | config.metricResultStoppedAt과 같습니다. |
| content.declaration | object | 현재 워크스페이스의 공통 선언입니다. |
| content.config.metricQueries.total.dql | string | 정규화 후 실행 쿼리입니다. |
| content.config.metricQueries.total.queryType | string | dql 또는 promql입니다. |
| content.config.metricQueries.total.promqlType | string | PromQL인 경우에만 반환되며 고정 값 instantQuery입니다. |
| content.config.metricQueries.total.editor | object | 호출자 편집기 에코 정보입니다. |
| content.config.metricQueries.total.editor.사용자 정의 필드 | JSON | 호출자가 전달한 동적 편집 상태이며 서버 실행 옵션으로 해석되지 않습니다. |
| content.config.metricQueries.good.dql | string | 정규화 후 실행 쿼리입니다. |
| content.config.metricQueries.good.queryType | string | dql 또는 promql입니다. |
| content.config.metricQueries.good.promqlType | string | PromQL인 경우에만 반환되며 고정 값 instantQuery입니다. |
| content.config.metricQueries.good.editor | object | 호출자 편집기 에코 정보입니다. |
| content.config.metricQueries.good.editor.사용자 정의 필드 | JSON | 호출자가 전달한 동적 편집 상태이며 서버 실행 옵션으로 해석되지 않습니다. |
| content.config.metricQueries | object | 메트릭 유형 전용이며 total과 good의 전체 정규화 구성입니다. |
| content.config.metricQueries.total | object | 총량 쿼리 구성입니다. |
| content.config.metricQueries.good | object | 성공량 쿼리 구성입니다. |
{
"code": 200,
"content": {
"id": null,
"uuid": "monitor_example",
"workspaceUUID": "wksp_example",
"name": "결제 서비스 가용성",
"type": "slo",
"score": 0,
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"config": {
"goal": 99.9,
"minGoal": 99.5,
"interval": "5m",
"checkRange": 604800,
"sliType": "monitor",
"describe": "결제 서비스 프로덕션 환경 SLO",
"groupBy": [],
"sli_infos": [
{
"id": "rul_example",
"name": "결제 인터페이스 성공률",
"status": 0
}
]
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
curl --request POST '<Endpoint>/api/v1/slo/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"결제 메트릭 성공률","sliType":"metric","goal":99.9,"minGoal":99.5,"interval":"5m","metricQueries":{"total":{"dql":"M::http_requests:(SUM(`total`))"},"good":{"dql":"M::http_requests:(SUM(`good`))"}}}'
{
"code": 200,
"content": {
"id": null,
"uuid": "monitor_example",
"workspaceUUID": "wksp_example",
"name": "결제 메트릭 성공률",
"type": "slo",
"score": 0,
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"config": {
"goal": 99.9,
"minGoal": 99.5,
"interval": "5m",
"checkRange": 604800,
"sliType": "metric",
"describe": "",
"groupBy": [],
"sli_infos": {},
"metricQueries": {
"total": {
"dql": "M::http_requests:(SUM(`total`))",
"queryType": "dql",
"editor": {}
},
"good": {
"dql": "M::http_requests:(SUM(`good`))",
"queryType": "dql",
"editor": {}
}
},
"metricResultValidAfter": 1785427200000,
"metricResultStoppedAt": null
},
"declaration": {},
"metricQueryInfo": {
"measurement": "slo_metric",
"sloId": "rul_slo_detect_example",
"validAfter": 1785427200000,
"stoppedAt": null
}
},
"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 객체를 제출합니다. |
| 400 | ft.ParamsValidateError | 메트릭 쿼리/주기/차원 등 공개된 필드의 비즈니스 조합이 유효하지 않음 | 파라미터 검증 실패: {} | 두 유형의 파라미터 제약에 따라 수정하고 원래 이름, 목표, 유형을 유지합니다. 서버 필드를 제출하지 마세요. |
| 400 | ft.SloNameRepeat | 현재 워크스페이스의 활성 SLO가 이미 해당 이름을 사용 중 | SLO 이름이 이미 존재합니다. 다시 입력하세요 | 먼저 목록으로 기존 객체를 조회하고, 업데이트가 필요하면 원래 uuid로 수정합니다. |
| 406 | ft.SloMinGoalGreaterThanGoal | minGoal이 goal보다 크거나 같음 | minGoal은 goal보다 작아야 합니다. 현재 minGoal: 99.9 goal: 99.9 |
0<minGoal<goal<100을 보장합니다. |
| 400 | ft.InvalidAlertPolicyUUID | alertPolicyUUIDs에 현재 워크스페이스의 유효한 정책이 아닌 항목이 포함됨 | 유효하지 않은 알림 정책 UUID | 현재 워크스페이스의 알림 정책 목록에서 다시 가져옵니다. |
| 400 | ft.TagScopeMismatch | 동일 이름의 기존 태그 scope에 monitor 또는 all이 포함되지 않음 | production: ['scene'] -> monitor | 모니터링에 사용할 수 있는 태그를 선택하고, 다른 전용 스코프의 동일 이름 태그를 직접 재사용하지 마세요. |
| 406 | ft.ExceedMaxCharacterLimit | 태그 이름이 128자를 초과함 | {} 최대 문자 길이 제한을 초과했습니다 | 태그 이름을 줄이고 비즈니스 식별 가능성을 유지합니다. |
| 400 | ft.FiledCreateTrigger | 생성 스케줄이 작업 ID 누락을 반환 | 트리거 구성 생성 실패, 다시 시도하세요 | 먼저 SLO와 잔여 작업을 확인한 후 스케줄을 수정/재시도합니다. |
| 400 | ft.OuterFuncFailed | 원격 스케줄 서비스가 실패를 반환 | 외부 함수 호출 실패(일부 분기는 다운스트림 message 사용) | message와 traceId를 확인하고, 관리자에게 스케줄 가용성 및 구성 현재 상태를 확인한 후 재시도하도록 요청합니다. |
| 400 | ft.SameSetTraggerExists | 원격 스케줄 서비스가 동일한 트리거 구성이 이미 존재한다고 보고 | 동일한 구성의 트리거가 이미 존재합니다 | 먼저 해당 SLO와 원격 스케줄을 확인하고, 잔여/중복 구성을 처리한 후 제출합니다. |
| 500 | ft.InternalServerError | 데이터베이스/캐시, 작업 큐, 잘못된 배열 멤버 또는 처리되지 않은 다운스트림 예외; 실패했더라도 원격 변경이 이미 있을 수 있음 | 내부 오류 | 먼저 대상 SLO 구성과 스케줄 현재 상태를 확인합니다. 삭제 실패는 삭제된 상태도 별도로 확인해야 하며, 무작정 반복 생성하거나 일괄 덮어쓰지 않습니다. |
| 403 | ft.ForbiddenQuery | 메트릭 유형 쿼리가 namespace 권한 검사를 통과했지만 현재 Key에 메트릭 조회 권한이 없음 | {} 권한이 없습니다 | Key 역할에 대상 메트릭 조회 권한을 보완하고, 동일 Key로 먼저 쿼리를 검증한 후 저장합니다. |