跳转至

创建一个静默规则



POST /api/v1/monitor/mute/create

概述

创建一个静默规则

Body 请求参数

参数名 类型 必选 说明
muteRanges array 沉默范围
例子: 监控器A
允许为空: False
tags json 标签集
允许为空: False
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 结束时间减去开始时间, 正整数,单位为 s
例子: 3600
允许为空: False
repeatExpireTime string 重复结束时间 %Y/%m/%d %H:%M:%S
例子:
允许为空: False
允许空字符串: True
timezone str Y 静默规则时区
例子: Asia/shanghai
允许为空: False
type str Y 静默规则类型
例子: custom
允许为空: False
可选值: ['checker', 'alertPolicy', 'tag', 'custom']

参数补充说明

数据说明.*

  • 请求参数说明
参数名 type 说明
muteRanges list 静默范围, 包含监控器,智能巡检,自建巡检, SLO,告警策略
tags dict 标签
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 重复静默的过期时间 %Y/%m/%d %H:%M:%S
timezone str 对应任务时区默认 Asia/shanghai
type str 对应静默规则类型 checker:monitor:tag:custom
repeatExpire int 重复静默的过期时间 (2023-08-24下架)
start int 静默开始时间 (2023-08-24下架)
end int 静默结束时间 (2023-08-24下架) |
notifyTime int 通知时间, 时间点对应的秒级时间戳, -1代表立即通知 (2023-08-24下架)

请求例子

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 '{"startTime":"2023/08/23 14:00:07","endTime":"2023/08/23 14:31:07","notifyTargets":[{"to":["acnt_861cf6dd440348648861247ae42909c3"],"type":"mail"}],"tags":{},"muteRanges":[{"name":"Aerospike 集群【{{cluster_name}}】空间【{{ ns }}】 的 Memory 使用率过高","checkerUUID":"rul_222bfe2ef8604f7291b23618eaf8fbdf","type":"监控器"}],"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_349ee5f70a89442fa94b4f754b5acbfe",
        "crontab": "",
        "crontabDuration": 0,
        "deleteAt": -1,
        "end": 1692772267,
        "endTime": "2023/08/23 14:31:07",
        "id": 643,
        "muteRanges": [
            {
                "checkerUUID": "rul_222bfe2ef8604f7291b23618eaf8fbdf",
                "name": "Aerospike 集群【{{cluster_name}}】空间【{{ ns }}】 的 Memory 使用率过高",
                "type": "监控器"
            }
        ],
        "notifyMessage": "cjkackcnkjcklasc",
        "notifyTargets": [
            {
                "to": [
                    "acnt_861cf6dd440348648861247ae42909c3"
                ],
                "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_349ee5f70a89442fa94b4f754b5acbfe",
        "uuid": "mute_bbced316fa284362aed50395a63d2e72",
        "workspaceUUID": "wksp_63107158c47c47f78ec222f51e3defef"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-C5BE0235-BB41-437E-801E-F925E98F8616"
} 

文档评价

文档内容是否对您有帮助? ×