首页

添加监视器 API - 虚拟化

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

VMware ESX/ESXi Server

语法

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

请求参数

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

字段描述
type要添加的监视器的类型。值应为VMware ESX / ESXi。
host运行VMWare ESX / ESXi服务器的主机的名称。
port运行VMware ESX / ESXi服务器的端口号。
usernameVMware ESX / ESXi服务器的用户名。
passwordVMware ESX / ESXi服务器的密码。
addtoGroup表示是否应将监视器添加到业务组。值是yes还是no
groupID业务组ID
monitorvms

指示如何监控ESX Server虚拟机的方式。可能的值为：

  • 否-将不会发现VM。
  • 仅可用性-将发现VM，但将不监控指标。（将不计入许可）
  • 是-将发现并监控VM。

示例请求

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=e249ce592ad1052c4ea605bcf3125ad9&type=VMWare ESX/ESXi&displayname=vnwgroup&host=esx-2&port=443&username=root&password=password&addToGroup=true&groupID=10000024&monitorvms=onlyavailability

VMware Horizo​​n View连接代理

您可以通过以下两种方式添加VMware Horizo​​n View Connection Broker监视器：

  • 将VMware Horizo​​n View添加为新的业务组（新建业务组-> VMware Horizo​​n View），这将发现Horizo​​n View设置中的所有组件，包括View Connection Broker。

    语法

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

    示例请求

    http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=f6ad2a431bb2cd5aa85c195262daef7f&type=VMwareView&displayname=HorizonView&host=172.18.144.52&username=vmwarehzview\user-test&password=APM@13&pollInterval=5

     

  • 将VMware Horizo​​n View Connection Broker添加为新监视器（新建监视器-> VMware Horizo​​n View Connection Broker）。这将单独发现View连接代理。

    语法

    http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=ViewConnectionBroker&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL]&addtoGroup=[TRUE/FALSE]&groupID=[GROUPID]

    示例请求

    http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=f6ad2a431bb2cd5aa85c195262daef7f&type=ViewConnectionBroker&displayname=ViewBroker&host=172.18.144.52&username=vmwarehzview\maran-test&password=Zoho@13&pollInterval=5&addtoGroup=true&groupID=10000028

请求参数

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

字段描述
type要添加的监视器的类型。值应为VMwareView或ViewConnectionBroker。
host运行VMware Horizo​​n View服务器的主机的名称。
usernameVMware服务器的用户名。
password您的VMware服务器的密码。

Microsoft Hyper-V Server

语法

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

请求参数

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

字段描述
type要添加的监视器的类型。值应为Hyper-V服务器。
hostHyper-V服务器运行所在的主机的名称。
passwordHyper-V服务器的密码。
addvms

指示如何监控Hyper-V服务器的虚拟机（VM）。可能的值为：

  • 否-将不会发现VM。
  • onlyavailability-将发现VM，但将不监控指标。（将不计入许可）
  • 是-将发现并监控VM。
usernameHyper-V服务器的用户名。
VersionMicrosoft Hyper-V服务器的版本。可能的值为2008、2012、2016或2019。

示例请求

http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84&type=Hyper-V Server&host=amp-w2k8-64&displayname=apmhyperv&password=admin123app2&addvms=yes&username=administrator&Version=2008

Citrix Hypervisor (XenServer)

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE] &host=[HOST]&displayname=[DISPLAYNAME]&username=[USERNAME]&password=[PASSWORD]&port=[PORT]&credentialID=[ CREDENTIALID ]&addvms=[ADDVMS]&addToGroup=[TRUE/FALSE]&groupID=[GROUPID]&monitorvms=[AVAILABILITY]

请求参数

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

字段描述
type要添加的监视器的类型。值应为XenServerHost。
hostXenServerHost运行所在的主机的名称。
passwordXenServerHost的密码
addvms表示是否应该收集VM的性能指标。值是yes或no
usernameXenServerHost的用户名
addToGroup表示是否应将监视器添加到业务组。值是yes还是no
groupID业务组ID
monitorvms指示监控虚拟机的方式。可能的值为no，yes和onlyavailability。值no表示将不会发现VM。值是表示将发现并监控VM。值onlyavailability表示将发现VM，但不监控指标（不计入许可）。

示例请求

  • http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194 &type=XenServerHost&host=192.18.3.75&displayname=newxen&username=root&password=sankho&addvms=yes&monitorvms=yes
  • http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194 &type=XenServerHost&host=192.18.3.75&displayname=newxen&addvms=yes&monitorvms=yes&credentialID=1

Citrix Virtual Apps (XenApp)

语法

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

请求参数

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

字段描述
key通过管理标签中的生成API密钥选项生成的密钥。
type您要添加的监视器的类型。该值应为XenApp。
hostXenApp服务器运行所在的主机的名称。
displayname监视器的显示名称。
usernameXenApp服务器主机的用户名。
passwordXenApp服务器主机的密码。
VersionXenApp的版本。

示例请求

http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=XenApp&host=192.18.3.75&displayname=XenAppServer&UserName =administrator&Password=pass&Version=7.6

vCenter

语法

  • http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
    &displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL]&addtoGroup=[ADDTOGROUP]&groupID=[GROUPID]&discoverVM=[DISCOVER VMS]&sslVersion=[SSL VERSION]
  • http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]
    &displayname=[DISPLAYNAME]&vcHost=[VC HOST]&vcPort=[VC PORT]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL]&discoverVM=[DISCOVER VMS]&sslVersion=[SSL VERSION]&isHostDCViaVC=[on/off]

请求参数

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

字段描述
type要添加的监视器的类型。值应为vCenter。
vcHost正在运行vCenter的主机的名称。
vcPortvCenter运行所在的端口号。
usernamevCenterServer的用户名。
passwordvCenterServer的密码。
addtoGroup表示是否应将监视器添加到业务组。值是yes还是no
isHostDCViaVC指定是否应该使用vCenter凭证进行数据收集。值可以on或off。（可选参数）。
discoverVM

指示如何监控vCenter的虚拟机（VM）的方式。可能的值为：

  • 0-将不会发现VM。
  • 1-将发现VM，但将不监控指标。（不会算作许可）
  • 2-将发现和监控VM。
sslVersion指定为vCenter配置的SSL版本。这些值可以是以下值之一：SSLv3，TLSv1，TLSv1.1或TLSv1.2。默认值为TLSv1.2。

示例请求

http://prod-server1:6060/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=vCenter&displayname=vctest&vcHost=vcenter&vcPort=443&username=test&password=test&pollInterval=10&discoverVM=2&sslVersion=TLSv1.2&isHostDCViaVC=true

Docker

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&sslenabled=[SSL Enabled]&isAllContainerEnabled=[All Container Enabled]&isCertificateEnabled=[Certificate Enabled]&clientCertName=[Client Certificate Name]&keystorePassword=[Client Certificate Password]

请求参数

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

字段描述
type要添加的监视器的类型。值应为 Docker.
hostDocker运行所在的主机的名称。
portDocker运行的端口号。
usernameDocker服务器的用户名。
passwordDocker服务器的密码。
sslenabled启用S​​SL的选项。可能的值为true或false。
isAllContainerEnabled用于发现和监控Docker服务器下可用的所有容器的选项。可能的值为true或false。
isCertificateEnabled为要监控的Docker服务器启用客户端证书身份验证的选项。可能的值为true或false。
clientCertName客户证书名称。
keystorePassword客户端证书使用的密码。

示例请求

没有证书:

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=dd2e6f7ec54632b4493d0dc13829df39&type=Docker&displayname=docker&host=testing&port=4243&username=&password=&isSSLEnabled=false&isAllContainerEnabled=true&isCertificateEnabled=false

有证书:

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=dd2e6f7ec54632b4493d0dc13829df39&type=Docker&displayname=docker&host=testing&port=4243&username=&password=&isSSLEnabled=true&isAllContainerEnabled=true&isCertificateEnabled=true&clientCertName=abcd&keystorePassword=abcd123

Kubernetes

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&mode=SSH&sshPKAuth=[true/false]&prompt=[Prompt]&timeout=[Timeout in Seconds]

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

字段描述
type要添加的监视器的类型。值应为Kubernetes.
hostKubernetes集群运行所在的主机的名称。
portKubernetes运行所在的端口号。
usernameKubernetes集群的用户名。
passwordKubernetes集群的密码。
modeKubernetes的访问方式。
sshPKAuth启用公共密钥身份验证（仅支持SSH2），即用于SSH身份验证的SSH密钥。
prompt指定命令提示符值，该值是命令提示符中的最后一个字符。默认值为$，可能的值为>，＃等。
timeout超时值（以秒为单位）。

示例请求

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=0b0e064274e52eead3d1cabdd5ceee04&type=Kubernetes&displayname=kubemaster&host=kubemaster&port=22&username=test&password=test&mode=SSH&sshPKAuth=false&prompt=$&timeout=40

Red Hat Virtualization (RHV)

语法

http://[ Host ]:[ Port ]/AppManager/xml/AddMonitor?apikey=[ API KEY ]&type=[ TYPE ]&displayname=[ DISPLAY NAME ]&host=[ HOST NAME ]&port=[ PORT ]&username=[ USERNAME ]&password=[ PASSWORD ]&pollInterval=[ POLL INTERVAL ]&timeout=[ TIMEOUT ]&discoverVM=[ DISCOVER VM ]

请求参数

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

参数描述
type您要添加的监视器的类型。该值应为RHEV。
host运行RHV服务器的主机的名称。
portRHV服务器运行的端口号。
usernameRHV服务器的用户名。
passwordRHV服务器的密码。
discoverVM

指示如何监控RHV服务器的虚拟机。可能的值为：

  • 1-发现处于不被管状态的虚拟机，并且仅监控VM的健康状况和可用性。
  • 2-发现处于托管状态的虚拟机并监控所有定义的指标。

示例请求

http://localhost:8989/AppManager/xml/AddMonitor?apikey=47e71c777772a41d1482a394070aaae6&type=RHEV&displayname=rhevtest&host=apm-rhvm1.csez.zohocorpin.com&port=443&username=admin@internal&password=NewPassword&pollInterval=5&timeout=300&discoverVM=2

Kernel-based Virtual Machine (KVM)

语法:

http://[ APPMANAGER_HOSTNAME ]:[ APPMANAGER_PORT ]/AppManager/xml/AddMonitor?apikey=[ APIKEY ]&type=[ TYPE ]&HostName=[ HOSTNAME ]&displayname=[ DISPLAYNAME ]&mode=[ MODE ]&snmptelnetport=[ PORT ]&username=[ USERNAME ]&password=[ PASSWORD ]&timeout=[ TIMEOUT ]&AddVMS=[ DISCOVERVMs ]

包括凭证管理

Telnet 模式:

http://[ APPMANAGER_HOSTNAME ]:[ APPMANAGER_PORT ]/AppManager/xml/AddMonitor?apikey=[ APIKEY ]&type=[ TYPE ]&HostName=[ HOSTNAME ]&displayname=[ DISPLAYNAME ]&mode=TELNET&snmptelnetport=[ PORT ]&credentialID=[ CREDENTIALID ]&timeout=[ TIMEOUT ]&AddVMS=[ DISCOVERVMs ]&TelnetCredentialDetails=cmTelnet

SSH 模式:

http://[ APPMANAGER_HOSTNAME ]:[ APPMANAGER_PORT ]/AppManager/xml/AddMonitor?apikey=[ APIKEY ]&type=[ TYPE ]&HostName=[ HOSTNAME ]&displayname=[ DISPLAYNAME ]&mode=SSH&snmptelnetport=[ PORT ]&credentialID=[ CREDENTIALID ]&timeout=[ TIMEOUT ]&AddVMS=[ DISCOVERVMs ]&SSHCredentialDetails=cmSSH

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

参数描述
type您要添加的监视器的类型。该值应为KVM。
HostnameKVM服务器运行所在的主机的名称。
modeKVM服务器的监控模式。可能的值为SSH和TELNET。
snmptelnetportKVM服务器运行的端口号。
usernameKVM服务器的用户名。
passwordKVM服务器的密码。
AddVM

指示如何监控KVM服务器的虚拟机（VM）的方式。可能的值为：

  • 0-将不会发现VM。
  • 1-将发现VM，但将不监控指标。（不会算作许可）
  • 2-将发现和监控VM。

示例请求:

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=25314fffa16c5975235d56564198e1ba&type=KVM&HostName=kvm-server&displayname=kvm&mode=TELNET&snmptelnetport=23&username=test&password=pwd&timeout=40&AddVMS=2

包含凭证管理

Telnet 模式:

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=25314fffa16c5975235d56564198e1ba&type=KVM&HostName=kvm-server&displayname=kvm&mode=TELNET&snmptelnetport=23&credentialID=3&timeout=40&AddVMS=2&TelnetCredentialDetails=cmTelnet

SSH 模式:

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=25314fffa16c5975235d56564198e1ba&type=KVM&HostName=kvm-server&displayname=kvm&mode=SSH&snmptelnetport=23&credentialID=3&timeout=40&AddVMS=2&SSHCredentialDetails=cmSSH

OpenShift

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OpenShift &displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&mode=SSH&sshPKAuth=[true/false]&prompt=[Prompt]&OSUsername=[OpenShift Username]&OSPassword=[OpenShiftPassword]&timeout=[Timeout in Sec]&apiMode=[true/false]&OSPort=[OS Port]&OSToken=[Service Account Token]

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

参数描述
type监视器类型。值应为OpenShift。
displayname监视器的显示名称
host托管计算机的名称。
portOpenShift运行所在的端口号。
username主机服务器的用户名。
password主机服务器的密码。
mode认证方式。值应为SSH。
sshPKAuth是否启用SSH2。值应为true或false。
prompt指定命令提示符值，该值是命令提示符中的最后一个字符。
OSUsernameOpenShift服务器的用户名。
OSPasswordOpenShift服务器的密码。
apiMode选择通过REST API收集Openshift环境的主要指标。可能的值为true或false。
OSPortOpenShift服务器的端口。
OSTokenOpenShift服务器管理员用户的服务帐户令牌。

示例请求

http://localhost:7700/AppManager/xml/AddMonitor?apikey=6e793c8d4c9b811181258bcd3ce7dde6&type=OpenShift&displayname=openshift&host=openshift&port=22&username=openshift&password=Server@123&mode=SSH&sshPKAuth=false&prompt=$&OSUsername=admin&OSPassword=admin&timeout=40

使用凭证ID:

http://localhost:7700/AppManager/xml/AddMonitor?apikey=6e793c8d4c9b811181258bcd3ce7dde6&type=OpenShift&displayname=openshift&host=openshift&port=22&mode=SSH&credentialID=1&OSUsername=admin&OSPassword=admin&timeout=40

通过REST API收集主要指标:

http://localhost:7700/AppManager/xml/AddMonitor?apikey=6e793c8d4c9b811181258bcd3ce7dde6&type=OpenShift&displayname=openshift&host=openshift&port=22&username=openshift&password=Server@123&mode=SSH&sshPKAuth=false&prompt=$&OSUsername=admin&OSPassword=admin&timeout=40&apiMode=true&OSPort=8443&OSToken=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9

Oracle VM (OVM)

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API KEY]&type=[TYPE]&displayname=[DISPLAY NAME]&host=[HOST NAME]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL]&discoverVM=[DISCOVER VM]&credentialID=[CREDENTIAL ID]&timeout=[TIMEOUT]

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

参数描述
type您要添加的监视器的类型。该值应为OVM。
hostOVM服务器运行所在的主机的名称。
portOVM服务器运行的端口号。
usernameOVM服务器的用户名。
passwordOVM服务器的密码。
discoverVM

指示如何监控OVM服务器的虚拟机（VM）。可能的值为：

  • 0-将不会发现VM。
  • 1-将发现VM，但将不监控指标。（不会算作许可）
  • 2-将发现和监控VM。
TimeoutOracle VM Manager的服务器连接超时值（以秒为单位）。

示例请求

  • http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=f2fe671bf966e8607382fe9af59e9136&type=OVM&displayname=ovmmanager&host=172.24.158.227&port=7002&username=admin&password=Oracle2019&pollInterval=2&discoverVM=2&timeout=300
  • http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=f2fe671bf966e8607382fe9af59e9136&type=OVM&displayname=ovmmanager&host=172.24.158.227&port=7002&pollInterval=2&discoverVM=2&timeout=300&credentialID=1

受到世界各地客户的喜爱

"具有广泛监控功能的Standout工具"

★★★★★

它允许我们跟踪关键指标，如响应时间、资源利用率、错误率和交易性能。实时监控告警会及时通知我们任何问题或异常，使我们能够立即采取行动。

审稿人角色：研究与开发

我喜欢Applications Manager，因为它可以帮助我们检测服务器和SQL数据库中存在的问题。
卡洛斯·里韦罗

Lexmark技术支持经理

受到全球6000多家企业的信任

我们的客户