添加监视器 API - Web服务器/服务

本节说明如何使用添加监视器API添加Web服务器/服务类别类型的监视器。支持以下监视器：

Apache Server

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME] &host=[HOST]&port=[PORT]&serverstatusurl=[SERVERSTATUSURL]&apacheurl=[APACHEURL]

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 要添加的监视器的类型。值应为Apache Server.
host 运行Apache服务器的主机的名称。
port Apache服务器运行的端口号。
apacheauth 表示是否对Apache服务器进行了身份验证。可能的值为true和false。
apacheUserName Apache服务器的用户名。仅当apacheauth值为true时才需要。
apachepassword Apache服务器的密码。仅当apacheauth值为true时才需要。
sslenabled 指示是否启用SSL。该值应为on 或者off
serverstatusurl 指示是否可以修改Apache服务器状态URL。该值应为true或false。
apacheurl Apache服务器状态网址。 示例: http://<host-name:portNumber>server-status?auto

示例请求

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84&type=Apache Server&displayname=apmapache&host=shakthiprian&port=8080&serverstatusurl=true&apacheurl=ddss

Apache Solr

语法

  • http://[Host]:[Port]http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE]
  • http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE]&UserName=[USERNAME]&Password=[PASSWORD]

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 要添加的数据库的类型。值应为Apache Solr
displayname Apache Solr监视器的显示名称
host 运行Apache Solr服务器的主机的名称。
port 运行Apache Solr服务器的端口号。
SSL 表示是否启用SSL。值应为true或false

示例请求

  • http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=ApacheSolr&displayname=SolrInstance&host=app-xp2&port=8993&ssl=false
  • http://localhost:9080/AppManager/xml/AddMonitor?apikey=a5f75b0fd164d85bb6730b0c78a5af86&type=ApacheSolr&displayname=SolrInstance&host=localhost&port=7574&ssl=false&UserName=solr&Password=SolrRocks

IIS Server

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]sslenable=[true/false]

请求参数:

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 要添加的监视器的类型。值应为 IIS Server.
host 运行IIS的主机的名称。
port IIS运行所在的端口号。
sslenabled 指定是否在IIS服务器中启用SSL。可能的值为True / False。

示例请求:

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=IIS Server&displayname=apmiis&host=app-xp2&port=80sslenable=true

Nginx Server

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPALYNAME]&host=[HOST]&port=[PORT]&sslenable=[TRUE/FALSE]&nginxauth=[TRUE/FALSE]&username=[USERNAME]&password=[PASSWORD]&nginxstatusurl=[NGNIX STATUS URL]

请求参数:

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 要添加的监视器的类型。值应为Nginx.
host Nginx服务器运行所在的主机的名称。
port Nginx服务器运行的端口号。
nginxauth 表示是否对Nginx服务器进行了身份验证。可能的值为true和false。
username Nginx服务器的用户名。仅当nginxauth值为true时才需要。
password Nginx服务器的密码。仅当nginxauth值为true时才需要。
nginxstatusurl Nginx服务器状态URL。该值应为true或false。请在nginxstatusurl的前缀中插入/（斜杠），如下所示。

示例请求:

http://operation-server9:9091/AppManager/xml/AddMonitor?apikey=a7867d64c831a50f8eb5be8bcfebab34&type=Nginx&displayname=apmnginx&host=deepak&port=8080&sslenable=true&nginxauth=true&username=deepak&password=deepak&nginxstatusurl=/nginx_status

PHP

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&serverpath=[SERVERPATH]

请求参数:

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 要添加的监视器的类型。值应为 PHP.
host 运行PHP的主机的名称。
port 运行PHP的端口号。
serverpath 用于连接的路径。默认值为/phpstats.php

示例请求:

http://operation-server9:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=PHP&displayname=apmiis&host=myesuraj&port=80&serverpath=/phpstats.php

Real Browser 监视器 (RBM)

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
&displayname=[DISPLAYNAME]&rbmagentID=[RBMAGENTID]&timeout=[TIMEOUT]&scriptname=[SCRIPTNAME]

请求参数:

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 要添加的监视器的类型。值应为 RBM.
rbmagentID RBM代理的ID。
timeout 超时值（以秒为单位）。
scriptname Web脚本的名称。

示例请求:

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858
&type=RBM&displayname=RBM_test&rbmagentID=10000000&timeout=15&scriptname=newS

URL 监视器

语法:

http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=[type]&displayname=[displayname]&timeout=[timeout]&url=[httpurl]&urlMethod=[method]&httpCondition=[condition]&httpValue=[responseCode]&checkForContent=[matchContent]&pollInterval=[pollInterval]&regex=true&casesensitive=true

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 要添加的监视器的类型。值应为 Url监视器。
displayname 要创建的监视器的名称。
timeout 超时值（以秒为单位）。
url 您要监控的HTTP / HTTPS URL地址。
urlMethod 此方法指定如何发送表单数据。值应分别为Get和Post的G / P。
httpCondition 错误响应代码条件。值应为LT / GT / EQ / NE / LE / GE（默认GT）。
httpValue 响应代码号，监视器将根据该代码显示为正常或停机（默认为200）。
requestParams 指定请求参数（例如，用户名，密码）。
checkForContent 内容匹配的关键字。
verifyError 错误验证的关键字。
errorIfMatch 输入一个关键字，该关键字与URL中的内容匹配时必须通知错误。注意：搜索区分大小写。多个关键字应放在引号中。否则，它将被视为多个关键字之一
username 如果URL需要基于表单的身份验证，请提供用户名。
password 如果URL需要基于表单的身份验证，请提供密码。
payload 指定POST表单提交方法的有效负载类型。类型为FORM，Text，XML，JSON。
regex 指定用于内容检查的内容是否包含正则表达式。如果要启用它，此字段的值应为true。
casesensitive 指定是否要进行区分大小写的关键字搜索。如果要启用它，则该字段的值应为true。
userAgent 设置用户代理以监控URL。（可以添加值，例如Mozilla / 5.0（兼容； MSIE 9.0； Windows Phone OS 7.5； Trident / 5.0； IEMobile / 9.0）））
sslVersion 指定为URL配置的SSL版本。这些值可以是以下值之一：SSLv3，TLSv1，TLSv1.1或TLSv1.2。默认值为自动。（非强制性参数）

示例请求:

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=UrlMonitor&displayname=appmanager&timeout=60&url=http://appmanager.com&urlMethod=G&httpCondition=EQ&httpValue=200&requestParams=username=appAdmin%0Apassword=adminPass%0Arole=admin&checkForContent=Applications&verifyError=Exception&errorIfMatch=quit&regex=true&casesensitive=true

Web Server

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]
&host=[HOST]&port=[PORT]

请求参数:

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 要添加的监视器的类型。值应为 Web Server.
host Web服务器运行所在的主机的名称。
port Web服务器运行的端口号。

示例请求:

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=90c166a4646e29315a57eca1d6b88858&type=Web Server&displayname=apmweb&host=app-xp2&port=80

SSL 证书监视器

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=SSLCertificateMonitor&displayname=[displayName]&domain=[domain]&port=[port]&monitorLeafCertOnly=[true/false]

请求参数:

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 要添加的监视器的类型。值应为 SSL证书监视器
host 运行SSL证书监视器的主机的名称。
port 运行SSL证书监视器的端口号。
domain 输入需要监控其SSL证书的域名。
isProxyNeeded 如果服务器通过代理连接，则使用isProxyNeeded。可能的值为：
  • isProxyNeeded = true
  • isProxyNeeded = false
ignoreHostNameError 指定是否要忽略SSL证书名称不匹配错误。可能的值为：
  • ignoreHostNameError = true
  • ignoreHostNameError = false
monitorLeafCertOnly 选择忽略无效的根证书和中间证书。如果未传递值，则假定为true。（true或false）
Timeout 输入超时值（以秒为单位）。

示例请求:

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=SSLCertificateMonitor&displayname=SSLCertificateMonitor&domain=www.zoho.com&port=443&timeout=60&monitorLeafCertOnly=false

Elasticsearch 监视器

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&ssl=[true/false]&DiscoverAllNodes=[Yes/No]

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
apikey 通过管理标签中的生成API密钥选项生成的密钥。
type 要添加的监视器的类型。值应为ElasticSearchCluster。
displayname Elasticsearch监视器的显示名称。
host 运行Elasticsearch服务器的主机的名称。
port Elasticsearch服务器运行的端口号。
ssl 指定是否启用SSL。值可以是true或false。
DiscoverAllNodes 指定是否要在Elasticsearch集群中发现节点。（YES/NO）

示例请求

http://localhost:9097/AppManager/xml/AddMonitor?apikey=7c18de184b2c8b1caa8d65790b382f32&type=ElasticSearchCluster&displayname=localhost&host=localhost&port=9200&ssl=false

要发现节点：

http://localhost:9097/AppManager/xml/AddMonitor?apikey=7c18de184b2c8b1caa8d65790b382f32& DiscoverAllNodes=Yes&type=ElasticSearchCluster&host=104.49.30.30&port=9200&ssl=false&displayname=test

HAProxy 监视器

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=HAProxy&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&SSL=[TRUE/FALSE]

请求参数:

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
key 通过管理标签中的生成API密钥选项生成的密钥。
type 要添加的监视器的类型。值应为HAProxy。
displayname HAProxy监视器的显示名称。
host 运行HAProxy服务器的主机的名称。
port HAProxy服务器运行的端口号。
ssl 指定是否启用SSL。值可以是true或false。

Web 服务

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Web Service&displayname=[DISPLAYNAME]&WSDLUrl=[WSDLURL]&endPointUrl=[ENDPOINTURL]&resFulWebservice=[true/false]&haid=[Monitor GroupId]&username=[USERNAME]&password=[PASSWORD]&customHeaders[Custom Header]&authToken[Authentication Token]

请求参数:

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
WSDLUrl 添加监视器所需的WSDL URL。
endPointUrl 添加监视器所需的端点URL。
resFulWebservice 将此值设置为true以启用符合REST的Web服务。
haid 业务组标识。
username 该用户名必须调用 网络服务。
password 该密码需要调用 网络服务。
customHeaders 您可以使用我们的预定义标头，也可以创建自己的自定义标头来调用操作。
authToken 如果需要，提供身份验证令牌。

示例请求:

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=d0588c8b72c6e76713ac55c66e8d&type=Web Service&displayname=apmservice&WSDLUrl=http://www.dataaccess.com/webservicesserver/numberconversion.wso?WSDL&endPointUrl=http://www.dataaccess.com/webservicesserver/numberconversion.wso&timeout=30&resFulWebservice=true&haid=10001&username=user&password=pass123&customHeaders=test&authToken=authtoken

Nginx Plus

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=NginxPlus&displayname=[Display Name]&host=[Host Name]&port=[Port No]&ssl=[true/false]&UserName=[User Name](optional)&Password=[password](optional)

请求参数:

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
type 您要添加的服务的类型。值应为NginxPlus。
host Nginx Plus在其中运行的主机的名称。
ssl 是否启用SSL。值应为true或false。
port Nginx Plus运行所在的端口号。
username 有权访问Nginx Plus的用户名。
password 有权访问Nginx Plus的用户的密码。

示例请求:

http://localhost:9092/AppManager/xml/AddMonitor?apikey=961280ec3cd4c76b39c1c9fbd871c5b0&type=NginxPlus&displayname=FromAPI&host=demo.nginx.com&port=443&ssl=true&UserName=test&Password=test

ME ServiceDesk Plus

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&hostname=[HOST]&port=[PORT]&ssl=[TRUE/FALSE]&restapiKey=[RestAPIKey]&MonitorPGSQLDB=[MonitorPGSQLDB]&dbtype=[DBType]&DBHost=[DatabaseHost]&DBname=[DataBaseName]&DBPort=[DataBasePort]&DBUserName=[DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance=[instance]

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
Hostname 运行Servicedesk-Plus / SDP MSP的主机的名称或IP地址。
port Servicedesk-Plus / SDP MSP的运行端口。
SSL（如果启用）  指定是否为Servicedesk-Plus / SDP MSP启用SSL。
restapiKey 要在ServiceDesk Plus中生成新的API密钥，请按照以下步骤操作：
  • 登录到ServiceDesk Plus。
  • 转到顶部窗格中的个性化选项卡。
  • 点击API密钥生成。您可以选择永不过期选项或指定过期日期：
  • 如果选择永不过期选项，则在您生成新密钥之前，该密钥将在Applications Manager中使用。
  • 如果设置了到期日期，则必须在设置的时间段之后手动更新APM中的新密钥，以进行数据收集。
  • 点击生成。
    • 复制生成的API密钥以在Applications Manager中使用它。
MonitorPGSQLDB 使用YES/NO指定是否要监控 PGSQL数据库。在UI中显示相应的选项卡取决于此值。（区分大小写）
DBType 数据库类型。值可以是pgsql或mssql。（区分大小写）
DB名称，DB端口，DB用户名和DB密码 PostgresSQL数据库凭证。
SSLEnabled 如果启用了SSL，则为True。

示例请求

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5b43655d12396a7917e5d5b036ced3aa&type=SDPMonitor&displayname=satya_sdp&hostname=satyavani-0618&port=8081&ssl=false&restapiKey=5B7ADE19-D4D7-4556-9F54-07FAF42D2C29&MonitorPGSQLDB=Yes&dbtype=[DBType]&DBHost=[DatabaseHost]&DBname=[DataBaseName]&DBPort=[DataBasePort]&DBUserName=[DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance=[instance]

ME OpManager

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OPMMonitor&hostname=[HOST]&port=[PORT]&authEnabled=[true/false]&username=[USERNAME]&password=[PASSWORD]&displayname=[DISPLAYNAME]&JNDIPath=[JNDIPATH]&MonitorPGSQLDB=[Yes/No]&dbtype=[DBType]&DBHost=[DatabaseHost]&DBname=[DataBaseName]&DBPort=[DataBasePort]&DBUserName=[DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance=[instance]&SSLEnabled=[SSLEnabled]

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
Hostname 运行ME OPManager的主机的名称或IP地址。
port ME OPManager的运行端口。
authEnabled 指定是否为ME OPManager启用身份验证。
username and password 用户的凭证。
JNDIPath JNDIPATH用于安装OpManager
MonitorPGSQLDB 使用YES/NO指定是否要监控 PGSQL数据库。在UI中显示相应的选项卡取决于此值。（区分大小写）
DBType 数据库类型。值可以是pgsql或mssql。（区分大小写）
DB名称，DB端口，DB用户名和DB密码 PostgresSQL数据库凭证。
SSLEnabled 如果启用了SSL，则为True。

示例请求

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=38cb51649cf3ac0614c3aab294a7bebd&type=OPMMonitor&hostname=172.21.151.93&port=1998&authEnabled=false&username=&password=&displayname=testOPM&JNDIPath=/jmxrmi&MonitorPGSQLDB=Yes&dbtype=pgsql&DBHost=172.21.151.93&DBPort=13306&DBname=OpManagerDB&DBUserName=postgres&namedInstance=[IsNameInstance]&instance=[instance]&SSLEnabled=false

ME ADManager Plus

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=ADMPMonitor&hostname=[HOST]&port=[PORT]&authEnabled=[AUTHENABLED]&username=[USERNAME]&password=[PASSWORD]&displayname=[DISPLAYNAME]&JNDIPath=[JNDIPATH]&MonitorPGSQLDB=[Yes/No]&dbtype=[DBType]&DBHost=[DatabaseHost]&DBname=[DataBaseName]&DBPort=[DataBasePort]&DBUserName=[DataBaseUserName]&DBPassword=[DBPassword]&namedInstance=[IsNameInstance]&instance=[instance]&SSLEnabled=[SSLEnabled]

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段 描述
Hostname 运行ADManager Plus的主机的名称或IP地址。
port ADManager Plus的运行端口。
authEnabled 指定是否启用身份验证。
username and password 用户的凭证。
displayname ADManager Plus监视器的显示名称。
JNDIPath 用于安装ADManager Plus的JNDIPATH。
MonitorPGSQLDB 使用YES/NO指定是否要监控 PGSQL数据库。在UI中显示相应的选项卡取决于此值。（区分大小写）
dbtype 数据库类型。值可以是pgsql或mssql。（区分大小写）
DB名称，DB端口，DB用户名和DB密码 PostgresSQL数据库凭证。
SSLEnabled 指定是否为ADManager Plus启用SSL。

示例请求

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=3be1ffd5109b27613464da89545964ba&type=ADMPMonitor&hostname=localhost&port=1991&authEnabled=false&username=&password=&displayname=test&JNDIPath=/jmxrmi&MonitorPGSQLDB=Yes&dbtype=pgsql&DBHost=satyavani-0618&DBname=DB&DBPort=13306&DBUserName=postgres&DBPassword=postgres&namedInstance=false&SSLEnabled=false

REST API 监视器

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API Key]&type=RESTAPIMonitor&displayname=[Display Name]&API=[REST API URL]&Timeout=[Timeout Value in Seconds]&Method=[GET/POST/PUT/DELETE]&RespType=[XML]&UserName=[Username]&Password=[Password]

请求参数

API请求中涉及的参数如下所述。另外，请参阅常见的请求参数列表.

参数 描述
type 要添加的监视器的类型。值应为RESTAPI监视器
displayname 监视器的显示名称。
API 要监控的API调用。
Timeout APM与托管API服务的服务器建立连接所花费的时间（以秒为单位）。
Method 用于访问API的表格提交方法。（GET/POST/PUT/DELETE）
RespType 预期的响应类型。（Text/XML/JSON）。
payLoadType 发送请求数据的格式（仅适用于POST和PUT方法）。值可以是FORM，Text，XML或JSON。
payLoad 请求数据（格式应与指定的payLoadType相匹配）。
customHeaders 指定标题以与API服务器建立连接。使用sep分隔标题名称和值。要指定多个标头，请使用分隔符＃（如果它们是通过GET发送的，请对请求参数进行编码）。

示例请求

http://Prod-server7:9010/AppManager/xml/AddMonitor?apikey=8519e4fadfd79d5dc78bce7489bd9319&type=RESTAPIMonitor&displayname=Dummy&API=https://www.google.co.in/&Timeout=10&Method=POST&payLoadType=Text&payLoad=PayloadContent&customHeaders=Accept_sep_application/json; version=2.0#User-Agent_sep_Mozilla/5.0 (Windows NT 6.3;Win64; x64)&UserName=User1&Password=Pass_123