添加监视器 API - 中间件/Portal

本节说明如何使用添加监视器API添加类别类型中间件/Portal的监视器。支持以下监视器：

MS Office SharePoint

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&version=[SHAREPOINT VERSION]&SPType=[SHAREPOINT TYPE]&Powershell=[IS POWERSHELL ENABLED]&Services=[SHAREPOINT SERVICES]

请求参数

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

字段 描述        
type 要添加的监视器的类型。值应为 MSOfficeSharePointServer.
version 该版本的Microsoft Office SharePoint服务器的。可能的值为2007、2010、2013、2016或2019。
host Office SharePoint服务器运行所在的主机的名称。
username SharePoint服务器的用户名。
password SharePoint服务器的密码。
SPType SharePoint服务器类型。可能的值为：
  • Farm -如果服务器有 Farm 设置.
  • SPServer-如果服务器有 Stand Alone 设置.
Powershell (optional): 指定是否启用Powershell。可能的值为：
  • True - 如果PowerShell是启用。
  • False - 如果未启用Powershell。
Service (optional):
版本 字段名称 可能的值
2007 Service ExcelServices/DocumentConversions/OfficeSearchGatherer
2010 & 2013 Services SharepointServices/ContentDB/WebApplication/TimerJobs/AccessServices/InfoPathServices/VisioWebAccess Services/ExcelServices/OfficeSearchGatherer
2016 & 2019 SP2016Services SharepointServices/ContentDB/WebApplication/TimerJobs/AccessServices/InfoPathServices/VisioWebAccess Services/SearchServices

示例请求

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=4df5040d6db873dcdaf4359b259fd494&type=MSOfficeSharePointServer&displayname=ms&host=app-server&username=administrator&password=admin123&version=2010&SPType=SPServer&Powershell=True& Services=SharepointServices,ContentDB,WebApplication,TimerJobs,AccessServices,InfoPathServices,VisioWebAccess Services,ExcelServices,OfficeSearchGatherer

WebLogic Integration

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version=[VERSION]

请求参数:

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

字段 描述        
type 要添加的监视器的类型。值应为 WebLogic Integration.
host 运行WebLogic Integration服务器的主机的名称。
port WebLogic Integration服务器运行的端口号。
username WebLogic Integration服务器的用户名。
password WebLogic Integration服务器的密码。
version WebLogic Integration服务器版本。值是 8.1

示例请求:

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313&type=WebLogic Integration&displayname=apm&host=app-server&port=7001&username=weblogics&password=weblogic&version=8.1

IBM WebSphere MQ

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&listenerport=[PORT]&displayname=[DISPLAYNAME]&serverconnectionchannel=[SERVERCONNECTIONCHANNEL]&Queue%20Manager=[QUEUEMANAGER]&AuthEnabled=[AUTHENABLED]&username=[USERNAME]&password=[PASSWORD]&MonitorBroker=[MONITORBROKER]&v10=[ISV10]&BrokerPort=[BROKERPORT]&BrokerAuthEnabled=[BROKERAUTHENABLED]&brokerusername=[BROKERUSERNAME]&brokerpassword=[BROKERPASSWORD]

请求参数:

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

字段 描述        
type 要添加的监视器的类型。值应为 IBM WebSphere MQ.
host 运行WebSphere MQ服务器的主机的名称。
listenerport IBM WebSphere MQ服务器的侦听器端口号。
displayname 监视器的显示名称。
serverconnectionchannel WebSphere MQ客户端通过其进行通信的服务器连接信道。
Queue Manager WebSphere MQ客户端通过其进行通信的队列管理的名称。
SSLEnabled 指定是否启用SSL。值是true还是false。
SSLCipherSpec SSL密码规范的名称。
AuthEnabled  指定是否启用身份验证。可能的值为true或false。
username  连接Websphere MQ队列管理的用户名。
password  连接Websphere MQ队列管理的密码。
FilterSysObject  筛选器系统对象。可能的值为true或false。
SysObjects  要监控的系统对象。
MonitorBroker  指定是否启用MessageBroker。可能的值为true或false。
v10 IIB  指定版本是否为10或更高。可能的值为true或false。
BrokerPort  IBMIntegrationBus（MessageBroker）的端口号。如果不适用，请提供0。
BrokerAuthEnabled  指定是否启用BrokerAuthentication。可能的值为true或false。
brokerusername  连接到Websphere Message Broker的用户名。
brokerpassword  连接到Websphere Message Broker的密码。 

示例请求:

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=IBM%20Websphere%20MQ&host=app-server&listenerport=1416&displayname=mqws&serverconnectionchannel=SCCHANEL1&Queue%20Manager=QMANAGER_QA1&AuthEnabled=true&username=test&password=test&&MonitorBroker=true&v10=true&BrokerPort=4416&BrokerAuthEnabled=true&brokerusername=test&brokerpassword=test

Microsoft Message Queue (MSMQ)

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]

请求参数:

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

字段 描述        
type 要添加的监视器的类型。值应为 Microsoft MQ.
host 运行Microsoft MQ服务器的主机的名称。
username MSMQ服务器的用户名
password MSMQ服务器的密码

示例请求:

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84&type=Microsoft MQ&displayname=msmq&host=app-server&username=administrator&password=password

RabbitMQ

语法:

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

请求参数:

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

字段 描述 
type 表示要添加的监视器的类别类型。该值应为RabbitMQ。
host 运行RabbitMQ服务器的主机的名称。
port RabbitMQ服务器运行的端口号。
username RabbitMQ服务器服务器的用户名。
password RabbitMQ服务器服务器的密码。

示例请求:

http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=VMware vFabric tc Server&displayname=vFabric&host=app-server&port=6969&username=admin&password=admin123&JNDIPath=/jmxrmi

Microsoft BizTalk

语法

http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=BizTalkServer&displayname=[DISPLAYNAME]&host=[BIZTALKHOST]&Version=[2013/2016]&UserName=[USERNAME]&Password=[PASSWORD]&PowerShell=[TRUE/FALSE]&CredSSP=[YES/FALSE]&DBServer=[DBSERVERHOST]&DBname=[BIZTALKMANAGEMENTDBDBname]

请求参数

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

字段 描述        
type 要添加的监视器的类别类型。该值应为BizTalkServer。
host BizTalk安装所在的主机的名称。
Version Biztalk应用程序的版本
  • 2013-如果Biztalk版本为2013或更低
  • 2016-如果Biztalk版本是2016
UserName BizTalk服务器主机的用户名。
Password BizTalk服务器主机的密码。
PowerShell 是否启用了Powershell？值是：
  • True - 已启用Powershell
  • False - Powershell已禁用
DBServer 存储配置数据库的服务器的名称（仅在启用PowerShell时才需要）。
DBname 配置数据库的名称（仅在启用PowerShell时才需要）。
CredSSP 指定在选择使用Powershell选项时是否应使用CredSSP身份验证。如果需要启用credssp ，则值为yes。

示例请求

  • http://app-x5p:9400/AppManager/xml/AddMonitor?apikey=fcc04ce64410e0dd7ccf72371a79761c&type=BizTalkServer&displayname=BizTalk2016&host=apm-biz1-1&Version=2016&UserName=apm\administrator&Password=Pass123&PowerShell=True&CredSSP=False&DBServer=apm-biz1-1&DBname=BizTalkMgmtDb
  • http://app-x5p:9400/AppManager/xml/AddMonitor?apikey=ddc04ce64410e0dd7ccf72371a79761c&type=BizTalkServer&displayname=BizTalk2016&host=apm-biz16-1&Version=2013&UserName=apm\administrator&Password=Pass123&PowerShell=False&CredSSP=False

Oracle Tuxedo

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST] &SNMPPORT=[PORT]&snmpCommunityString=[COMMUNITYSTRING]&timeout=[TIMEOUT]

请求参数:

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

字段 描述  
type 要添加的监视器的类别类型。该值应为 Oracle Tuxedo.
host 安装Tuxedo的主机的名称。
displayname 监视器的显示名称。
SNMPPORT 在其上运行Tuxedo SNMP代理的SNMP端口号。默认端口号是 161。
snmpCommunityString Tuxedo SNMP代理的SNMP团体字符串。默认值为public。确保您使用的团体字符串至少包含只读权限。
timeout 超时（以秒为单位）。

示例请求:

http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=a169e7aa3b4656d0db29532fd4347&type=Oracle Tuxedo&displayname=Tuxedo&host=172.31.10.1&SNMPPORT=161&snmpCommunityString=public&timeout=40

Microsoft Skype for Business

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&Version=[VERSION]&Roles=[ROLES]

请求参数

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

字段 描述
type 您要添加的监视器的类别类型。该值应为 LyncServer。
host 运行Microsoft Skype for Business Server的主机的主机名或IP地址。
displayname 监视器的显示名称。
UserName 用于监控Microsoft Skype for Business Server的帐户的用户名。该帐户应包含访问Microsoft Skype for Business Server的管理员权限。
password 包含管理员权限以访问Microsoft Skype for Business Server的上述用户的密码。
Version 服务器上安装的Microsoft Skype for Business 2015或Microsoft Lync Server版本。可能的值为：
  • lync
  • sfb2015
Roles 提供您希望监控的角色，以逗号分隔的值：
  • 前端服务器
  • A/V会话服务器
  • 边缘服务器
  • 中介服务器

示例请求

http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=4787dvds8941bc5a7b0db85d43a5b789&type=LyncServer&displayname=LyncAPI&host=172.31.10.1&UserName=APM\administrator&Password=pass&Version=sfb2015&Roles=FrontEndServer,A/V Conferencing Server,MediationServer

Azure Service Bus

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[AzureServiceBus]&displayname=[DISPLAYNAME]&SubscriptionId=[SUBSCRIPTIONID]&Namespace=[NAMESPACE]&Timeout=[TIMEOUT]

请求参数:

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

字段 描述        
SubscriptionID 使用的Azure订阅的订阅ID。
Namespace Service Bus 命名空间名称。
Timeout 超时（以秒为单位）。

示例请求:

http://anne-2394:9096/AppManager/xml/AddMonitor?apikey=35eb5a8f77a1595f9d9e575a7c3575ad &type=AzureServiceBus&displayname=azureapmsbadmin&SubscriptionId=1591f1b0-6e8c-461f-8916-df7954193ec2&Namespace=applicationsmanager&Timeout=20

Apache ActiveMQ

语法:

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[apikey]&type=ApacheActiveMQ&displayname=[Displayname]&HostName=[HostName]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi

请求参数:

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

字段 描述
type 要添加的数据库的类型。值应为 ApacheActiveMQ.
display name ActiveMQ监视器的显示名称。
hostname 运行ActiveMQ服务器的主机的名称。
port 运行ActiveMQ服务器的端口号。
username 有权访问Apache ActiveMQ服务器的用户名。
JNDIPath 要使用的JNDI路径。

示例请求:

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=ff5db35538c534e24dc2154cffbc7e6e&type=ApacheActiveMQ&displayname=Success&HostName=app-w8-aio-5&Port=1099&UserName=&Password=&JNDIPath=/jmxrmi

Apache Kafka

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API KEY]&type=Kafka&displayname=[Displayname]&HostName=[Hostname]&Port=[Port]&UserName=[UserName]&Password=[Password]&JNDIPath=/jmxrmi

请求参数

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

字段 描述
type 要添加的数据库的类型。值应为 Kafka.
display name Kafka监视器的显示名称。
hostname Kafka服务器运行所在的主机的名称。
port Kafka服务器运行的端口号。
username 有权访问Apache Kafka服务器的用户名。
JNDIPath 要使用的JNDI路径。

示例请求

http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=15c64bc4cca4a3c45d0369fca1877e8a&type=Kafka&displayname=Kafka&HostName=172.20.8.62&Port=9999&UserName=&Password=&JNDIPath=/jmxrmi