생성¶

POST /api/v1/monitor/mute/create

개요¶

음소거 규칙을 생성합니다.

Body 요청 파라미터¶

파라미터명	유형	필수	설명
muteRanges	array		음소거 범위 비어 있음 허용: False
name	string		규칙 이름 예시: 이름 A 비어 있음 허용: False
description	string		설명 예시: 설명 A 비어 있음 허용: False 빈 문자열 허용: True
tags	json		태그 집합 비어 있음 허용: False
filterString	string		이벤트 속성 비어 있음 허용: False 빈 문자열 허용: True 최대 길이: 2048
notifyTargets	array		알림 대상 비어 있음 허용: False
notifyMessage	string		알림 메시지 비어 있음 허용: False 최대 길이: 3000
notifyTimeStr	string		알림 시간, %Y/%m/%d %H:%M:%S 예시: 2023/08/21 19:19:00 비어 있음 허용: False 빈 문자열 허용: True
startTime	string		시작 시간 %Y/%m/%d %H:%M:%S 예시: 2023/08/21 19:19:00 비어 있음 허용: False
endTime	string		종료 시간 %Y/%m/%d %H:%M:%S 예시: 2023/08/21 19:19:00 비어 있음 허용: False 빈 문자열 허용: True
repeatTimeSet	int	Y	반복 설정 값은 1, 음소거 시간이 단일이면 0 예시: 0 비어 있음 허용: False
repeatCrontabSet	None		반복 crontab 설정 비어 있음 허용: False
repeatCrontabSet.min	string		분 예시: 10 비어 있음 허용: False
repeatCrontabSet.hour	string		시 예시: 10 비어 있음 허용: False
repeatCrontabSet.day	string		일 예시: * 비어 있음 허용: False
repeatCrontabSet.month	string		월 예시: * 비어 있음 허용: False
repeatCrontabSet.week	string		주 예시: 1,3 비어 있음 허용: False
crontabDuration	int		종료 시간에서 시작 시간을 뺀 값, 양의 정수, 단위는 초 예시: 3600 비어 있음 허용: False
repeatExpireTime	string		반복 종료 시간 %Y/%m/%d %H:%M:%S 예시: 0 비어 있음 허용: False 빈 문자열 허용: True
timezone	str	Y	음소거 규칙 시간대 예시: Asia/Shanghai 비어 있음 허용: False
type	str	Y	음소거 규칙 유형 예시: custom 비어 있음 허용: False 선택 가능한 값: ['checker', 'alertPolicy', 'tag', 'custom']
declaration	json		사용자 정의 선언 정보 비어 있음 허용: False

파라미터 추가 설명¶

데이터 설명.*

1. 요청 파라미터 설명

파라미터명	type	설명
type	string	해당 음소거 규칙 유형: 모니터:checker, 알림 정책:monitor, 모니터 태그:tag, 사용자 정의:custom
muteRanges	list	음소거 범위, 모니터, 지능형 점검, 자체 호스팅 점검, SLO, 알림 정책 포함
name	str	규칙 이름
description	str	설명
tags	dict	고급 설정, 이벤트 속성
filterString	str	이벤트 속성(표현식 형태로 전달)
notifyTargets	list	to: 목록은 알림 대상, type은 알림 유형
repeatTimeSet	int	반복 음소거 여부, 1은 반복 음소거 활성화, 0은 한 번만
repeatCrontabSet	dict	반복 음소거 규칙의 시간 설정
crontabDuration	int	해당 예약 작업 시작 후 음소거 지속 시간
notifyTargets	list	to: 목록은 알림 대상, type은 알림 유형
notifyTimeStr	str	알림 시간, %Y/%m/%d %H:%M:%S
startTime	str	음소거 시작 시간 %Y/%m/%d %H:%M:%S
endTime	str	음소거 종료 시간 %Y/%m/%d %H:%M:%S
repeatExpireTime	str	0은 영구 반복, 반복 음소거 만료 시간 %Y/%m/%d %H:%M:%S
timezone	str	해당 작업 시간대, 기본값 Asia/Shanghai
repeatExpire	int	반복 음소거 만료 시간 (2023-08-24에 폐기됨)
start	int	음소거 시작 시간 (2023-08-24에 폐기됨)
end	int	음소거 종료 시간 (2023-08-24에 폐기됨)
notifyTime	int	알림 시간, 시간 포인트에 해당하는 초 단위 타임스탬프, -1은 즉시 알림 (2023-08-24에 폐기됨)
declaration	dict	사용자 정의 선언 정보
--------------

2. 음소거 범위 설명

파라미터명	type	필수	설명
type	string	Y	해당 음소거 규칙 유형: 모니터:checker, 알림 정책:monitor, 모니터 태그:tag, 사용자 정의:custom
muteRanges	list	Y	음소거 범위, []는 전체 선택
tags	dict	Y	고급 설정, 이벤트 속성
filterString	str	이벤트 속성(표현식 형태로 전달)

tags 설정은 역선택 구성을 지원합니다. 예시:

{
    "tags": {
        "-host": [
            "cn-hangzhou"
        ]
    },
    "muteRanges": [],
    "type": "checker"
}

type이 checker(모니터 유형)인 경우 예시:

{
    "tags": {
        "host": [
            "cn-hangzhou"
        ]
    },
    "muteRanges": [
        {
            "name": "인프라 생존 탐지-유형이 ReplicaSet- {{Result}}",
            "checkerUUID": "rul_xxxx22",
        },
        {
            "name": "hhh",
            "checkerUUID": "rul_xxxx21",
        }
    ],
    "type": "checker"
}

type이 alertPolicy(알림 정책 유형)인 경우 예시:

{
    "tags": {
        "host": [
            "cn-hangzhou"
        ]
    },
    "muteRanges": [
        {
            "name": "gary-test1234",
            "alertPolicyUUID": "altpl_xxxx26",
        }
    ],
    "type": "alertPolicy",
}

type이 tag(모니터 태그)인 경우 예시:

{
    "tags": {
        "service": [
            "kodo.nsq.consumer"
        ]
    },
    "muteRanges": [
        {
            "name": "zyl_test",
            "tagUUID": "tag_xxxx23",
        },
        {
            "name": "0306",
            "tagUUID": "tag_xxxx28",
        }
    ],
    "type": "tag"
}

type이 custom(사용자 정의 유형)인 경우 예시:

name="__codelineno-4-1">{ "tags": { "service": [ "kodo.nsq.consumer" ] }, "muteRanges": [ { "name": "모니터 최적화 검증-업데이트2", "checkerUUID": "rul_xxxx22", }, { "name": "0306", "tagUUID": "tag_xxxx25", }, { "name": "slo_test", "sloUUID": "monitor_xxxx25", } ], "type": "custom", }

filterString은 새로운 버전의 이벤트 속성이며, 구문은 탐색기 구문을 따릅니다. 현재 인터페이스는 이전 버전 이벤트 속성인 tags와도 호환되며, filterString의 값을 우선적으로 사용합니다. 예시:

{
    "filterString": "df_status:ok OR host:web001",
    "muteRanges": [],
    "type": "checker"
}

3. 음소거 시간 설명

음소거 시간은 단일 음소거와 반복 음소거로 구분됩니다.

단일 음소거의 파라미터 설정:

파라미터명	type	설명
repeatTimeSet	int	반복 음소거 여부, 1은 반복 음소거 활성화, 0은 한 번만
startTime	str	음소거 시작 시간 %Y/%m/%d %H:%M:%S
endTime	str	음소거 종료 시간 %Y/%m/%d %H:%M:%S
timezone	str	해당 작업 시간대, 기본값 Asia/Shanghai

repeatTimeSet이 0인 단일 음소거 예시:

{
    "startTime": "2024/03/27 14:06:57",
    "endTime": "2024/03/27 15:06:57",
    "timezone": "Asia/Shanghai",
    "repeatTimeSet": 0
}

반복 음소거의 파라미터 설정:

파라미터명	type	설명
repeatTimeSet	int	반복 음소거 여부, 1은 반복 음소거 활성화, 0은 한 번만
repeatCrontabSet	dict	반복 음소거 규칙의 시간 설정, 시작 Crontab(Crontab 구문) 구성에 사용됨
crontabDuration	int	해당 예약 작업 시작 후 음소거 지속 시간, 단위 초
repeatExpireTime	str	0은 영구 반복, 반복 음소거 만료 시간 %Y/%m/%d %H:%M:%S
timezone	str	해당 작업 시간대, 기본값 Asia/Shanghai

repeatTimeSet이 1인 반복 음소거 예시:

{
    "timezone": "Asia/Shanghai",
    "repeatTimeSet": 1,
    "repeatCrontabSet": {
        "min": "0",
        "hour": "0",
        "day": "*",
        "month": "*",
        "week": "1,2"
    },
    "crontabDuration": 18000,
    "repeatExpireTime": "0"
}

요청 예시¶

curl 'https://openapi.guance.com/api/v1/monitor/mute/create' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data-raw '{"name":"nameA","description":"descA","startTime":"2023/08/23 14:00:07","endTime":"2023/08/23 14:31:07","notifyTargets":[{"to":["acnt_xxxx32"],"type":"mail"}],"tags":{},"muteRanges":[{"name":"The Memory usage rate of the Aerospike cluster [{{cluster_name}}] space [{{ns}}] is too high","checkerUUID":"rul_xxxx32","type":"checker"}],"type":"checker","timezone":"Asia/Shanghai","notifyMessage":"cjkackcnkjcklasc","notifyTimeStr":"2023/08/23 13:45:07","repeatTimeSet":0}' \
  --compressed \
  --insecure

응답¶

{
    "code": 200,
    "content": {
        "createAt": 1692771116,
        "creator": "acnt_xxxx32",
        "crontab": "",
        "crontabDuration": 0,
        "deleteAt": -1,
        "description": "descA",
        "end": 1692772267,
        "endTime": "2023/08/23 14:31:07",
        "id": 643,
        "muteRanges": [
            {
                "checkerUUID": "rul_xxxx32",
                "name": "The Memory usage rate of the Aerospike cluster [{{cluster_name}}] space [{{ns}}] is too high",
                "type": "checker"
            }
        ],
        "name": "nameA",
        "notifyMessage": "cjkackcnkjcklasc",
        "notifyTargets": [
            {
                "to": [
                    "acnt_xxxx32"
                ],
                "type": "mail"
            }
        ],
        "notifyTime": 1692769507,
        "notifyTimeStr": "2023/08/23 13:45:07",
        "repeatExpire": -1,
        "repeatExpireTime": "-1",
        "start": 1692770407,
        "startTime": "2023/08/23 14:00:07",
        "status": 0,
        "tags": {},
        "timezone": "Asia/Shanghai",
        "type": "checker",
        "updateAt": 1692771117,
        "updator": "acnt_xxxx32",
        "uuid": "mute_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-C5BE0235-BB41-437E-801E-F925E98F8616"
}

생성¶

개요¶

Body 요청 파라미터¶

파라미터 추가 설명¶

요청 예시¶

응답¶

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

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