数据开放接口 / 数据开放接口之下发指令接口(需要升级到v4.0.1或以上版本)
如果其它平台或者AI想调用接口给监控主机发送指令,就可以使用调用此接口给指定的主机下发指令
调用接口发送指令后,先由管理员或者成员账号在【指令下发】页面进行审核,点击【同意下发】后,指令状态由【等待审核】改为【下发中】,然后
才真正开始下发指令给agent,agent会在5分钟内负责执行完成指令,并上报执行结果给server端
如果不点击审核【同意下发】按钮,指令将永远不会下发。当然,您也可以取消下发指令或者删除指令,这两个操作都会永久取消指令下发
如果下发指令功能在server配置文件已经关闭,那么调用此接口也无法下发指令
如果指令含有server配置文件中的非法字符串,也无法下发指令,具体配置请往下看第3条说明
提示:此接口默认是关闭状态(不可用),没有开放使用,如果要使用此接口的话,我们先修改下server配置文件参数shellOpenAPI
如何修改呢?请往下看第3条说明如何修改配置
1、示例,下面【2】是参数说明:
此接口主要给有告警需求的第三方系统使用,就可以调用此接口实现告警消息推送,会同步推送给WGCLOUD已配置的告警方式(邮件、钉钉、微信等),同时会记录到系统日志中
2、参数说明:
3、如何开启下发指令接口,如何关闭下发指令接口呢
下发指令接口默认是关闭的,如果我们想要使用下发指令的接口,可以手动修改下参数开启它,请看下面说明如何开启此接口,如何关闭此接口
我们打开server的配置文件server/config/application.yml,修改如下参数shellOpenAPI为no即可,然后重启server程序生效
如果配置文件没有shellOpenAPI这个参数,那我们手动添加下也可以的,就添加到如下位置,注意对齐格式
提示:只有shellToRun和shellOpenAPI两个参数值都为yes时,只有满足这个条件,调用下发指令接口才能成功下发指令