添加监视器 API - 服务

---

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

• Active Directory
• Ceph Storage
• DNS 监视器
• FTP/SFTP 监视器
• Hadoop 监视器
• JMX Applications
• LDAP Server
• Ping 监视器/Ping 监视器 (EUM)
• Service 监控
• SNMP/Network Device
• Telnet
• Oracle Coherence
• Apache Zookeeper
• Apache Spark

Active Directory

语法

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

请求参数

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

字段	描述
type	您要添加的服务的类型。值应为ActiveDirectory。
host	运行Active Directory服务的主机的名称。
username	Active Directory用户名。
password	Active Directory密码。
Timeout	运行脚本的超时时间（以秒为单位）
CredSSP	指定当被监控的AD服务器是非主域控制器并且位于与Applications Manager服务器域不同的域中时，是否应使用CredSSP身份验证。如果需要启用CredSSP ，则值为Yes。

示例请求

http://operation-server3:9099/AppManager/xml/AddMonitor?apikey=123b7328e4b41d1efe64aa7980d83d77&type=ActiveDirectory&displayname=active_mon&host=app-xp4&username=administrator&password=admin123&timeout=300&CredSSP=Yes

Ceph Storage

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&prompt=[Prompt]&userName=[UserName]&password=[Password]&snmptelnetport=[PORT]&mode=[MODE OF MONITORING]&timeout=[TIMEOUT]

请求参数

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

字段	描述
type	您要添加的服务的类型。值应为Ceph存储。
host	运行Ceph服务的主机的名称。
username	Ceph存储服务用户名。
password	Ceph存储服务密码。
prompt	命令提示符值-'$'。如果使用＃，则仅v必须使用$ 23的编码值
snmptelnetport	运行Telnet / SSH服务的端口号。Telnet的默认端口为23，SSH的默认端口为22。
mode	您要使用的监控方式。值可以是Telnet或SSH。
Timeout	Applications Manager与托管API服务的服务器建立连接所花费的时间。默认情况下，超时值为40毫秒。

示例请求

http://operation-server3:9099/AppManager/xml/AddMonitor?apikey=5e403cfde0653d142fac29b18863923b&type=Ceph Storage&displayname=ceph&host=ctl-cephadmin&prompt=$&userName=appmgr&password=appmgr%123&snmptelnetport=22&mode=SSH&timeout=40

DNS监视器

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&timeout=[TIMEOUT]&SearchField=[SEARCHFIELD]&TargetAddress=[TARGETADDRESS]&LookupAddress=[LOOKUPADDRESS]&RecordType=[RECORDTYPE]

请求参数

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

字段	描述
type	您要添加的服务的类型。值应为DNSMonitor。
displayname	运行监视器的主机的显示名称。
Timeout	超时值（以秒为单位）。
SearchField	SearchField的值。选项包括无，记录名称，地址，附加名称，目标，管理，主机，别名，端口和优先级。
TargetAddress	主机名称/ IP地址以连接到服务
LookupAddress	您要在DNS服务器中检查的地址。
RecordType	返回查询地址的预期记录类型。选项包括A，AAAA，CNAME，MX，NS，PTR，SOA，SPF，SRV和TXT。

示例请求

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=DNSMonitor&displayname=dnstttttt&timeout=15&SearchField=Record Name&TargetAddress=192.168.4.121&LookupAddress=appmanager.com&RecordType=A

FTP/SFTP Monitor

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&TargetAddress=[TARGETADDRESS]&DownloadFile=[DOWNLOADFILE]&IsSecured=[ISSECURED]&UploadFile=[UPLOADFILE]&RemoteSourceFileName=[REMOTESOURCEFILENAME]&RemoteDestinationFileName=[REMOTEDESTINATIONFILENAME]&LocalSourceFileName=[LOCALSOURCEFILENAME]&LocalDestinationFileName=[LOCALDESTINATIONFILENAME]&timeout=[TIMEOUT]

请求参数

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

字段	描述
type	您要添加的服务的类型。值应为FTP监视器。
port	FTP / SFTP服务运行的端口号。
username	FTP / SFTP用户名。
password	FTP / SFTP密码。
TargetAddress	连接到服务的主机名/ IP地址。
DownloadFile	指示是否启用下载。可能的值包括 yes和 no。如果要在模拟下载文件时通过FTP / SFTP监控下载（mget），请指定 yes。
IsSecured	指定连接是否安全。值是 yes或 no。
UploadFile	指示是否启用了上载文件选项。值包括 yes和 no。如果要将文件上传到目标地址，请指定 yes。
RemoteSourceFileName	位于目标地址中的远程源文件名。仅在将DownloadFile选项的值指定为 yes时适用。
RemoteDestinationFileName	位于目标地址中的远程目标文件名。仅在将UploadFile选项的值指定为 yes时适用。
LocalSourceFileName	包含完整路径的本地源文件的名称。该文件必须在运行Applications Manager实例的位置可用。仅在将UploadFile选项的值指定为 yes时适用。
LocalDestinationFileName	包含完整路径的本地目标FileName。该文件将在运行Applications Manager实例的给定路径中下载。仅当DownloadFile选项的值指定为yes时，此字段才适用
Timeout	超时值（以秒为单位）。

示例请求

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=FTPMonitor&displayname=ladpapitestooooo&port=22&username=sprasadh&password=sprasadh&TargetAddress=sprasadh&DownloadFile=no&IsSecured=yes&UploadFile=no&RemoteSourceFileName=&RemoteDestinationFileName=&LocalSourceFileName=&LocalDestinationFileName=&timeout=15

Hadoop 监视器

注意：必须使用相同的模式（JMX或RESTAPI）添加NameNode和JobTracker / ResourceManager。

语法

1. 通过REST API监控模式添加Hadoop监视器：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname=[DISPLAYNAME]&ModeOfMonitoring=RESTAPI&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeWebPort=[NAMENODE WEBPORT]&NameNodeSSLEnabled=[yes/no]&NameNodeWebAuthType=[SimpleAuth/NoAuth]&NameNodeUserName=[NAMENODE USERNAME]&JobTrackerHost=[JOBTRACKER HOSTNAME]&JobTrackerWebPort=[JOBTRACKER WEBPORT]&JobTrackerSSLEnabled=[yes/no}&JobTrackerWebAuthType=[SimpleAuth/NoAuth]&JobTrackerUserName=[JOBTRACKER USERNAME]

2. 通过JMX监控模式添加Hadoop监视器：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Hadoop&displayname=[DISPLAYNAME]&ModeOfMonitoring=JMX&Version=[1.x/2.x]&NameNodeHost=[NAMENODE HOST]&NameNodeJMXPort=[NAMENODE JMXPORT]&NameNodeUserName=[NAMENODE JMX USERNAME]&NameNodePassWord=[NAMENODE JMX PASSWORD]&NameNodeJNDIPath=[NAMENODE JNDIPATH]&JobTrackereHost=[JOBTRACKER HOSTNAME]&JobTrackerJMXPort=[JOBTRACKER JMXPORT]&JobTrackerUserName=[JOBTRACKER JMX USERNAME]&JObTrackerPassWord=[JOBTRACKER JMX PASSWORD]&JobTrackerJNDIPath=[JOBTRACKER JNDIPATH]

请求参数

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

字段	描述
ModeOfMonitoring	Hadoop监视器的数据收集将发生的模式。 可能的值： RESTAPI JMX
Version	Hadoop版本。 可能的值： 1.x 2.x
NameNodeHost	Namenode的主机名。
NameNodeWebPort	Namenode的Web端口。
NameNodeJMXPort	Namenode的JMX端口
NameNodeSSLEnabled	是否为Namenode Webport启用了SSL？ 可能的值： yes no
NameNodeWebAuthType	名称节点Web使用的类型身份验证。 可能的值： 无认证 SimpleAuth
NameNodeUserName	Web访问的用户名，如果在namenode中使用了简单身份验证。 JMX访问的用户名（如果在namenode中选择了监控的JMX模式）。
NameNodePassWord	JMX访问的密码（如果namenode中的JMX访问必需）。
NameNodeJNDIPath	Namenode的JNDI路径。
JobTrackerHost	Jobtracker的主机名。
JobTrackerWebPort	Jobtracker的Web端口。
JobTrackerJMXPort	Jobtracker的JMX端口。
JobTrackerSSLEnabled	是否为Jobtracker网络端口启用了SSL？ 可能的值： yes no
JobTrackerWebAuthType	Jobtracker网站使用的类型身份验证。 可能的值： 无认证 SimpleAuth
JobTrackerUserName	Web访问的用户名，如果Jobtracker中使用了简单身份验证。 JMX访问的用户名（如果在Jobtracker中选择了监控的JMX模式）。
JObTrackerPassWord	JMX访问的密码，如果在Jobtracker中访问JMX是必需的。
JobTrackerJNDIPath	Jobtracker的JNDI路径。

示例请求

1. 通过REST API监控模式添加Hadoop监视器：

http://app-test-vm:9090/AppManager/xml/AddMonitor?apikey=90b71e0866f0f92488fbb4a2ab8d1195&type=Hadoop&displayname=Hadoop&ModeOfMonitoring=RESTAPI&Version=1.x&NameNodeHost=naga-2385&NameNodeWebPort=50070&NameNodeSSLEnabled=no&NameNodeWebAuthType=SimpleAuth&NameNodeUserName=hduser&JobTrackerHost=naga-2385&JobTrackerWebPort=50030&JobTrackerSSLEnabled=no&JobTrackerWebAuthType=SimpleAuth&JobTrackerUserName=hduser

2. 通过JMX监控模式添加Hadoop监视器：

http://app-test-vm:9090/AppManager/xml/AddMonitor?apikey=90b71e0866f0f92488fbb4a2ab8d1195&type=Hadoop&displayname=Hadoop&ModeOfMonitoring=JMX&Version=1.x&NameNodeHost=naga-2385&NameNodeJMXPort=8004&NameNodeUserName=&NameNodePassWord=&NameNodeJNDIPath=/jmxrmi&JobTrackerHost=naga-2385&JobTrackerJMXPort=8004&JobTrackerUserName=&JobTrackerPassWord=&JobTrackerJNDIPath=/jmxrmi

JMX 应用程序

语法

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

请求参数

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

字段	描述
type	您要添加的服务的类型。值应为JMX应用程序。
host	运行监视器的主机的名称。
port	运行RMI适配器的端口号。
jndiurl	JNDI名称。示例：/ jmxrmi

示例请求

http://prod-server1:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=JMX Applications&displayname=apmjmxapp&host=app-xp2&port=1099&jndiurl=/jmxrmi

LDAP Server

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&username=[USERNAME]&timeout=[TIMEOUT]&LDAPServer=[LDAPSERVER]&LDAPServerPort=[LDAPSERVERPORT]&MatchingAttribute=[MATCHINGATTRIBUTE]&FilterCondition=[FILTERCONDITION]&IsSecured=[ISSECURED]&SearchFilter=[SEARCHFILTER]&SearchResult=[SEARCHRESULT]&SearchBase=[SEARCHBASE]&password=[PASSWORD]

请求参数

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

字段	描述
type	您要添加的服务的类型。值应为LDAP服务器。
username	LDAP服务器的用户名。
Timeout	超时值（以秒为单位）。
LDAPServer	LDAP服务器的名称。
LDAPServerPort	LDAP服务器运行的端口。
MatchingAttribute	匹配的属性值。值包括cn，uid，sn，displayname，givenname，objectclass，dc和ou
FilterCondition	过滤条件的值。值包括equals，contains和notequals
IsSecured	指定连接是否安全。值是 yes或 no。
SearchFilter	搜索过滤器的值。该字段是可选的。
SearchResult	与搜索结果匹配的字符串值。
SearchBase	SearchBase的值。添加LDAP监视器时，这是必填字段。
password	LDAP服务器的密码。

示例请求

http://operations-server9:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=LDAP Server&displayname=ldap_serverqqqq&username=cn=administrator,cn=users,dc=pmp,dc=com&timeout=10&LDAPServer=pmp-2k8s&LDAPServerPort=389&MatchingAttribute=cn&FilterCondition=equals&IsSecured=no&SearchFilter=&SearchResult=&SearchBase=&Password=admin123123

Ping 监视器/Ping 监视器 (EUM)

语法

Ping监视器:

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

Ping 监视器 (EUM):

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

请求参数

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

字段	描述
type	您要添加的服务的类型。值应为Ping 监视器或Ping 监视器（EUM）。
displayname	监视器的显示名称。
host	运行监视器的主机。
Timeout	超时值（以秒为单位）。

示例请求

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=Ping 监视器&displayname=apmping&host=smrithil&timeout=5

服务监控

语法

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

请求参数

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

字段	描述
type	您要添加的服务的类型。价值应该是 服务监控。
host	运行监视器的主机。
Timeout	超时值（以秒为单位）。
port	运行服务的端口号。

示例请求

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=Service Monitoring&displayname=apmservice&host=smrithil&port=9090&timeout=3

SNMP/Network Device

语法

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

请求参数

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

字段	描述
type	您要添加的服务的类型。值应为 SNMP / Network Device。
host	运行监视器的主机。
port	运行SNMP的端口号。
snmpCommunityString	SNMP团体字符串值。默认值为 public。
Timeout	超时值（以秒为单位）。

示例请求

http://prod-server4:9099/AppManager/xml/AddMonitor?apikey=c9684ec1361be61f48cd1bd2221ac3fc&type=SNMP/Network Device&displayname=apmsnmp&host=sprasadh&port=161&snmpCommunityString=public&timeout=5

Telnet

语法

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

请求参数

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

字段	描述
type	您要添加的服务的类型。值应该是 telnet。
host	运行监视器的主机名。
Timeout	超时值（以秒为单位）。
port	运行Telnet的端口号。

示例请求

http://operation-server2:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=telnet&displayname=apmtelnet&host=smrithil&port=23&timeout=2

Oracle Coherence

语法

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

请求参数

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

字段	描述
key	用于创建Oracle coherence监视器的API密钥
type	要添加的数据库的类型。值应为 一致性。
displayname	Oracle coherence监视器的显示名称
Hostname	运行Oracle coherence的主机的名称。
port	Oracle运行所在的端口号。
username	有权访问Oracle coherence数据库的用户名。
password	有权访问Oracle coherence数据库的用户的密码。
JNDIPath	要使用的JNDI路径

示例请求

http://prod-server7:9090/AppManager/xml/AddMonitor?apikey=27d484c4527d4f0911daef26e131a260&type=Coherence&displayname=Coherence_API&HostName=it360-m4600-1&Port=1099&PortAdd=1095&UserName=admin&Password=Abc@123&JNDIPath=/jmxrmi

Apache Zookeeper

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Zookeeper&displayname=Zookeeper&host=[Host Name]&port=[Port Number]&discoverclusternodes=[non mandatory column, if given the value should be 'Yes']&authReq=[non mandatory column, if given the value should be 'true']&username=[username]&password=[password]

请求参数

The parameters involved in the API request are described below.

字段	描述
type	您要添加的服务的类型。值应该是Zookeeper。
host	运行Zookeeper的主机的名称。
port	Zookeeper运行所在的端口号。
username	有权访问Zookeeper的用户名。
password	有权访问Zookeeper的用户的密码。
discoverclusternodes	指定是否必须发现集群节点。值可以为YES/NO。此列不是必需的。
authReq	指定是否需要认证。值可以是true / false。

示例请求

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=Zookeeper&displayname=Zookeeper&host=172.20.7.36&port=7199&username=uname&password=123

Apache Spark

语法

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

请求参数

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

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

示例请求

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=849c51ce33436587873a08d69d5447fc&type=ApacheSparkMaster&displayname=Spark&host=172.20.7.36&port=7199&SSL=true&DiscoverAllNodes=yes