콘텐츠로 이동

생성¶

POST /api/v1/slo/add

개요¶

Body 요청 매개변수¶

매개변수명	유형	필수	설명
name	string	Y	SLO 이름 빈 값 허용: False 최대 길이: 256
interval	string	Y	검사 빈도 빈 값 허용: False 선택 가능 값: ['5m', '10m'] 예시: 5m
goal	float	Y	SLO 예상 목표, 값 범위: 0-100, 0, 100 미포함 빈 값 허용: False 선택 가능 값 (초과): 0 선택 가능 값 (미만): 100 예시: 90.0
minGoal	float	Y	SLO 최소 목표, 값 범위: 0-100, 0, 100 미포함, goal보다 작아야 함 빈 값 허용: False 선택 가능 값 (초과): 0 선택 가능 값 (미만): 100 예시: 85.0
sliUUIDs	array	Y	SLI UUID 목록 빈 값 허용: False 예시: ['rul-aaaaaa', 'rul-bbbbbb']
describe	string		SLO 그룹 설명 예시: 예시입니다 빈 값 허용: False 빈 문자열 허용: True 최대 길이: 3000
alertPolicyUUIDs	array		알림 정책 UUID 빈 값 허용: False
tags	array		필터링에 사용할 태그 이름 빈 값 허용: False 예시: ['xx', 'yy']
groupBy	array		SLO 계산 차원, project, env, service만 지원, DQL by 차원은 이 필드와 일치, 기본값 [] 빈 값 허용: False 예시: ['project', 'env']
ignoreBadGroupEvents	boolean		SLO에 groupBy 설정 시 비정상 그룹 이벤트 무시 여부, 기본값 true, groupBy 미설정 시 적용되지 않음 빈 값 허용: False 예시: True

매개변수 추가 설명¶

sliUUIDs, SLI의 uuid 목록 참고: 모니터링 - 모니터 - 모니터 목록 가져오기(search 매개변수로 모니터 이름 검색 가능, 다른 매개변수 생략)에서 모니터 uuid 필드 가져오기
alertOpt[#].alertTarget, 알림 대상 참고: 모니터링 - 알림 대상 관리 - 알림 대상 목록 가져오기

요청 예시¶

curl 'https://openapi.guance.com/api/v1/slo/add' \
-H 'Content-Type: application/json' \
-H 'DF-API-KEY:  <DF-API-KEY>' \
--data '{"name":"LWC-Test-2024-08-06-002","interval":"10m","goal":90,"minGoal":60,"sliUUIDs":["rul_xxxxx","rul_9eb745xx"],"describe":"LWCTestOpenAPI","tags":[],"alertPolicyUUIDs":["altpl_d8db4xxxx"],"groupBy":["project","env"],"ignoreBadGroupEvents":true}'

응답¶

{
    "code": 200,
    "content": {
        "alertOpt": {},
        "config": {
            "checkRange": 604800,
            "describe": "LWCTestOpenAPI",
            "goal": 90,
            "interval": "10m",
            "minGoal": 60,
            "sli_infos": [
                {
                    "id": "rul_7xxxx",
                    "name": "lml-tes",
                    "status": 0
                },
                {
                    "id": "rul_9xxxx",
                    "name": "whytest-Feedback Problem Verification",
                    "status": 2
                }
            ]
        },
        "createAt": 1722913524,
        "creator": "wsak_a2d5xxx",
        "creatorInfo": {
            "uuid": "xx",
            "status": 0,
            "username": "xx",
            "name": "xx",
            "iconUrl": "",
            "email": "xx",
            "acntWsNickname": "xx"
        },
        "declaration": {
            "asd": "aa,bb,cc,1,True",
            "asdasd": "dawdawd",
            "business": "aaa",
            "fawf": "afawf",
            "organization": "64fe7b4062f74d0007b46676"
        },
        "deleteAt": -1,
        "id": null,
        "name": "LWC-Test-2024-08-06-002",
        "score": 0,
        "status": 0,
        "type": "slo",
        "updateAt": 1706152340,
        "updator": "xx",
        "updatorInfo": {
            "uuid": "xx",
            "status": 0,
            "username": "xx",
            "name": "xx",
            "iconUrl": "",
            "email": "xx",
            "acntWsNickname": "xx"
        },
        "uuid": "monitor_5exxxxx",
        "workspaceUUID": "wksp_4b57cxxxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "12912524534614287758"
}