URI

/v2/service/create.json

Method

POST

参数说明:

Apache,Lighttpd,Nginx,MongoDB,Redis,Memcache,IIS,SQLServer

以上八种服务的创建格式为:

{

"task_name":"my_test",

"task_type":"nginx",

"frequency":"5",

"status_url":"http://127.0.0.1:8001/server-status",

"alert_setting":{

        "alert":{

            "email":12345,

            "push":12345,

            "wechat":12345,

            "remind":12345,

            "sms":12345,

          },

         "scope":"1",

         "organization":"",

"user_ids":""

}

}

 

MySQL

{

  "task_name":"mysql",

    "task_type":"mysql",

    "frequency":"5",

    "ip":"10.0.0.1",

    "port":"3306",

    "user":"admin",

    "password":"123456",

}

 

Tomcat

{

  "task_name":"tomcat",

    "task_type":"tomcat",

    "frequency":"5",

    "status_url":"http:// 127.0.0.1:8001/server-status",

    "appname":"http-bio-11106",

    "user":"admin",

    "password":"123456"

}

 

IIS

[

{

        "task_name":"my_iis_test",

        "task_type":"iis",

        "frequency":"5",

        "logPath":"C:\inetpub\logs\LogFiles\W3SVC2",

        "use_agent":"1",

        "plugin_task_uselist_id":"962"

  }

]

 

SQLServer

{

  "task_name":"my_sqlserver_test",

    "task_type":"sqlserver",

    "frequency":"5",

    "ip":"10.0.0.1",

    "port":"1433",

    "user":"admin",

    "password":"123456",

     "appname":"master"

}

 

Oracle

{

  "task_name":"my_oracle_test",

    "task_type":"oracle",

    "frequency":"10",

    "use_agent":"1",

    "plugin_task_uselist_id":"10000",

    "user":"admin",

    "password":"111111",

    "appname":"127.0.0.1:1521/orcl"

}

参数项

必填

描述

默认值

access_token

必填



task_name

必填

任务名称


task_type

必填

任务类型


frequency

选填[任务类型为 Oracle时为必选]

监控频率

五分钟 [任务类型为Oracle时为十分钟]

alert_setting

选填

告警设置


alert

选填

通知方式


email

选填

Email


sms

选填

短信


remind

选填

连续告警


wechat

选填

微信告警


push

选填

APP推送


use_agent

选填

是否使用插件 [0-不使用  1-使用] IIS服务监控功能只能使用采集器


plugin_task_uselist_id

选填

使用的关联插件ID,可通过插件API获得


user_ids

指定的部分用户的ID

只当‘scope’设置为4时才需设置,用户ID可通过列出所有用户获得


scope

必填

设置告警时任务公开范围

 [1-全企业用户, 2-指定用户组, 3-仅限本人   ,4-部分用户]


organization

选填

只当‘scope’设置为2时才需设置,分组ID可通过用户分组信息获得


其他参数

适用项目

参数项

必填

描述

默认值

Apache、Lighttpd、Nginx、MongoDB、Memcache、Redis

status_url

必填

状态页面URL


MySQL

ip

必填

MySQL服务器IP


port

必填

MySQL端口


user

必填

MySQL用户名


password

必填

MySQL密码


Tomcat

status_url

必填

Tomcat状态页


user

必填

Tomcat用户名


password

必填

Tomcat密码


appname

必填

所要监控服务名


IIS

logPath

必填

IIS服务器日志路径


SQLServer

ip

必填

SQLServer服务器的IP地址


port

必填

SQLServer端口


user

必填

SQLServer用户名


password

必填

SQLServer密码


appname

必填

数据库名


Oracle

user

必填

Oracle用户名


password

必填

Oracle密码


appname

必填

Oracle连接名


成功返回项说明:

[

  {

      "task_id": 21340

  }

]

 

返回项

类型

描述

task_id

String

创建的任务的ID

失败返回项说明:

{

      "code":400,

      "msg":"post内容为空"

}

返回项

类型

描述

code

String

错误码

msg

String

错误信息

 

调用示例:

curl -H "application/x-www-form-urlencoded" --data 'data=[{"task_name":"my_test","task_type":"nginx","frequency":"5","status_url":"http://127.0.0.1/server-status","alert_setting":{"alert":{"email":12345},"scope":"1","organization":"","user_ids":""}}]' "https://api.jiankongbao.com/v2/service/create.json?access_token=905710a098e1f02b7f4ec50d699d66f49a98e7f7"