URI | /v2/server/create.json | ||||||||
Method | POST | ||||||||
参数说明: [ { "server_name":"test", "private_ip":"60.28.201.230", "server_ip":"60.28.201.230", "server_systype":"0", "frequency":"5", "snmp_port":"161", "snmp_v":"0", "snmp_comm":"public", "snmp_user":"admin", "snmp_pass":"admin", "snmp_authtype":"0", "use_agent":"0", "plugin_task_uselist_id":"", "organization":"1", "user_ids":"1", "task_type":[ "cpu", "mem" ] } ] | |||||||||
参数项 | 必填 | 描述 | 默认值 | ||||||
access_token | 必填 | ||||||||
server_name | 必填 | 服务器名称 | |||||||
private_ip | 必填 | 服务器IP | |||||||
server_ip | 必填 | SNMP IP | |||||||
server_systype | 选填 | 系统类型 [0-Linux,1-Windows] | 0 | ||||||
frequency | 选填 | 监控频率 | 5 | ||||||
snmp_port | 必填 | SNMP代理端口 | |||||||
snmp_v | 必填 | SNMP传输协议版本[0-2C,1-3] | |||||||
snmp_comm | 选填 | Community | |||||||
snmp_user | 必填 | Security Name | |||||||
snmp_pass | 必填 | Pass Phrase | |||||||
snmp_authtype | 必填 | Auth Protocol [0-MD5,1-SHA] | |||||||
use_agent | 选填 | 是否使用采集器 [0-不使用,1-使用] | 0 | ||||||
plugin_task_uselist_id | 选填 | 采集器关联ID,可通过插件API来获得采集器的信息 | |||||||
注: 1、snmp_v类型选择3的时候不是必填项,如果是2c的话用户和密码不是必填项。 2、选择外网时,plugin_task_uselist_id不是必填项。 | |||||||||
为任务设置告警时的参数说明(alert_setting) | |||||||||
分类 | 参数项 | 必填 | 描述 | 默认值 | |||||
alert_setting | 选填 | 邮箱 [用户id] | |||||||
sms | 选填 | 短信 [用户id] | |||||||
remind | 选填 | Remind [用户id] | |||||||
push | 选填 | APP推送[用户id] | |||||||
选填 | 微信[用户id] | ||||||||
scope | 选填 | 任务公开范围[1-全企业用户,2-指定用户组,3-仅限本人,4-部分用户] 注:企业用户才需要设置 | [1-全企业用户] | ||||||
organization | 选填 | 指定用户组的分组ID[只当‘scope’设置为2时才需设置] 注:企业用户才需要设置 | |||||||
user_ids | 选填 | 指定用户[只当‘scope’设置为4时才需设置] 注:企业用户才需要设置 | |||||||
不为任务设置告警时参数说明 | |||||||||
参数项 | 必填 | 描述 | |||||||
organization | 选填 | 指定用户组的分组ID[只当‘scope’设置为2时才需设置] 注:企业用户才需要设置 | |||||||
user_ids | 选填 | 指定用户[只当‘scope’设置为4时才需设置] 注:企业用户才需要设置 | |||||||
task_type | 选填 | 服务器监控的任务指标[请参考备注] | 没有指标 | ||||||
备注: | |||||||||
Window服务器监控任务指标 | |||||||||
cpu_windows | 选填 | CPU | |||||||
mem_windows | 选填 | 内存 | |||||||
netio | 选填 | 网络流量 | |||||||
diskstore | 选填 | 磁盘空间 | |||||||
procsum | 选填 | 系统进程 | |||||||
Linux服务器监控任务指标 | |||||||||
cpu | 选填 | CPU | |||||||
load | 选填 | CPU负载 | |||||||
mem | 选填 | 内存 | |||||||
netio | 选填 | 网络流量 | |||||||
diskstore | 选填 | 磁盘空间 | |||||||
procsum | 选填 | 系统进程 | |||||||
diskio | 选填 | 磁盘I/O | |||||||
成功返回结果: [ { "task_id": 56001 } ] | |||||||||
返回项 | 类型 | 描述 | |||||||
task_id | String | 任务ID | |||||||
失败返回结果: { "code": 400, "msg": "您无权访问该服务器" } | |||||||||
返回项 | 类型 | 描述 | |||||||
code | String | 错误码 | |||||||
msg | String | 错误内容 |
调用示例:
curl -H "application/x-www-form-urlencoded" --data 'data= [{"server_name":"zkttest","private_ip":"60.28.201.230","server_ip":"60.28.201.230","server_systype":"0","frequency":"5","snmp_port":"161", "snmp_v":"0","snmp_comm":"public","snmp_user":"admin","snmp_pass":"admin","snmp_authtype":"0","use_agent":"0","plugin_task_uselist_id":"", "organization":"1","user_ids":"1","task_type":["cpu","mem"]}]' "https://api.jiankongbao.com/v2/server/create.json? access_token=269ccd91c64a452cab70f91961e53a801589e9fa"