跳转至

导入



POST /api/v1/checker/import

概述

导入一个/多个监控器配置

Body 请求参数

参数名 类型 必选 说明
checkers array Y 规则配置列表
允许为空: False
type string 智能监控导入传参 smartMonitor, 默认 为普通监控器 trigger
允许为空: False
允许为空字符串: False
可选值: ['smartMonitor', 'trigger']
skipRepeatNameCheck boolean 是否跳过重名检测, false 进行重名检测, true 为跳过重名检测
例子: False
允许为空: False
skipRepeatNameCreate boolean true 同名跳过创建, 不同名的直接创建, false 创建所有导入信息
例子: False
允许为空: False
deleteRepeatName boolean true 删除并导入同名监控器,默认为 false
例子: False
允许为空: False

参数补充说明

** 监控器模板配置,参见【监控器导出接口】**

相关参数说明. 返回结果 content 中存在 repeat_name,表示存在同名,添加参数 skipRepeatNameCreate 选择跳过或同名创建

参数名 type 必传 说明
checker array 必传 规则配置列表
skipRepeatNameCheck boolean 必传 是否跳过重名检测, 如不跳过(false):同名检测不通过则返回同名监控器名称列表
skipRepeatNameCreate boolean 必传 同名是否跳过创建,如不跳过(false):则会创建相同名称的监控器
deleteRepeatName boolean 非必传 是否删除并导入同名监控器,默认为 false

请求例子

curl 'https://openapi.guance.com/api/v1/checker/import' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"checkers":[{"extend":{"funcName":"","isNeedCreateIssue":false,"issueLevelUUID":"","needRecoverIssue":false,"querylist":[{"datasource":"dataflux","qtype":"dql","query":{"alias":"","code":"Result","dataSource":"ssh","field":"ssh_check","fieldFunc":"count","fieldType":"float","funcList":[],"groupBy":["host"],"groupByTime":"","namespace":"metric","q":"M::`ssh`:(count(`ssh_check`)) BY `host`","type":"simple"},"uuid":"aada629a-672e-46f9-9503-8fd61065c382"}],"rules":[{"conditionLogic":"and","conditions":[{"alias":"Result","operands":["90"],"operator":">="}],"status":"critical"},{"conditionLogic":"and","conditions":[{"alias":"Result","operands":["0"],"operator":">="}],"status":"error"}]},"is_disable":false,"jsonScript":{"atAccounts":[],"atNoDataAccounts":[],"channels":[],"checkerOpt":{"infoEvent":false,"rules":[{"conditionLogic":"and","conditions":[{"alias":"Result","operands":["90"],"operator":">="}],"status":"critical"},{"conditionLogic":"and","conditions":[{"alias":"Result","operands":["0"],"operator":">="}],"status":"error"}]},"disableCheckEndTime":false,"every":"1m","groupBy":["host"],"interval":300,"message":"message1","noDataMessage":"","noDataTitle":"","recoverNeedPeriodCount":2,"targets":[{"alias":"Result","dql":"M::`ssh`:(count(`ssh_check`)) BY `host`","qtype":"dql"}],"title":"Host {{ host }} SSH  error","type":"simpleCheck"},"monitorName":"default","secret":"","tagInfo":[],"type":"trigger"}]}' \
--compressed 

响应

{
    "code": 200,
    "content": {
        "declaration": {
            "business": "",
            "organization": "663dbba102482200070bbb02"
        },
        "rule": [
            {
                "createAt": 1756285080,
                "createdWay": "import",
                "creator": "wsak_22e2b98bd92b48ba9d92dcbd4e526f8e",
                "crontabInfo": {
                    "crontab": "0 */1 * * * *",
                    "id": "cron-LoiyL3IGSZaV"
                },
                "deleteAt": -1,
                "extend": {
                    "funcName": "",
                    "isNeedCreateIssue": false,
                    "issueLevelUUID": "",
                    "needRecoverIssue": false,
                    "querylist": [
                        {
                            "datasource": "dataflux",
                            "qtype": "dql",
                            "query": {
                                "alias": "",
                                "code": "Result",
                                "dataSource": "ssh",
                                "field": "ssh_check",
                                "fieldFunc": "count",
                                "fieldType": "float",
                                "funcList": [],
                                "groupBy": [
                                    "host"
                                ],
                                "groupByTime": "",
                                "namespace": "metric",
                                "q": "M::`ssh`:(count(`ssh_check`)) BY `host`",
                                "type": "simple"
                            },
                            "uuid": "aada629a-672e-46f9-9503-8fd61065c382"
                        }
                    ],
                    "rules": [
                        {
                            "conditionLogic": "and",
                            "conditions": [
                                {
                                    "alias": "Result",
                                    "operands": [
                                        "90"
                                    ],
                                    "operator": ">="
                                }
                            ],
                            "status": "critical"
                        },
                        {
                            "conditionLogic": "and",
                            "conditions": [
                                {
                                    "alias": "Result",
                                    "operands": [
                                        "0"
                                    ],
                                    "operator": ">="
                                }
                            ],
                            "status": "error"
                        }
                    ]
                },
                "id": null,
                "isLocked": false,
                "jsonScript": {
                    "atAccounts": [],
                    "atNoDataAccounts": [],
                    "checkerOpt": {
                        "infoEvent": false,
                        "rules": [
                            {
                                "conditionLogic": "and",
                                "conditions": [
                                    {
                                        "alias": "Result",
                                        "operands": [
                                            "90"
                                        ],
                                        "operator": ">="
                                    }
                                ],
                                "status": "critical"
                            },
                            {
                                "conditionLogic": "and",
                                "conditions": [
                                    {
                                        "alias": "Result",
                                        "operands": [
                                            "0"
                                        ],
                                        "operator": ">="
                                    }
                                ],
                                "status": "error"
                            }
                        ]
                    },
                    "disableCheckEndTime": false,
                    "every": "1m",
                    "groupBy": [
                        "host"
                    ],
                    "interval": 300,
                    "message": "message1",
                    "name": "Host {{ host }} SSH  error",
                    "noDataMessage": "",
                    "noDataTitle": "",
                    "recoverNeedPeriodCount": 2,
                    "targets": [
                        {
                            "alias": "Result",
                            "dql": "M::`ssh`:(count(`ssh_check`)) BY `host`",
                            "qtype": "dql"
                        }
                    ],
                    "title": "Host {{ host }} SSH  error",
                    "type": "simpleCheck"
                },
                "monitorUUID": "monitor_7dbd71a127f945c0a968f1e4582dd9c9",
                "openPermissionSet": false,
                "permissionSet": [],
                "refKey": "",
                "secret": null,
                "status": 0,
                "tagInfo": [],
                "type": "trigger",
                "updateAt": -1,
                "updator": "",
                "uuid": "rul_8e1a91ee842b4101ba23684f62b76fc0",
                "workspaceUUID": "wksp_84c4a0044edc4f878ea88e4517659bda"
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-5C22D448-A71E-469A-B054-10C5EBD4089E"
} 

文档评价

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