添加监视器 API

该API允许用户在Applications Manager中配置监视器。支持的不同监视器是：

请求参数

API请求中涉及的常用参数如下所述：

字段 描述
apikey * 通过管理标签中的 生成API密钥选项生成的密钥 。
displayname * 监视器的显示名称。
subnet 服务器正在运行的子网。默认值为225.225.225.0
pollInterval 服务器需要轮询的时间间隔。此变量是可选的。如果未提及任何值，将采用默认值5分钟。
groupID（haid） 业务组的ID。在Applications Manager中，可以使用以下方法找到业务组的groupID：
  • 点击业务组表中的组名 。这将打开业务组详细信息页面
  • 业务组详细信息页面的URL将采用以下格式：

    http://app-windows：9090 / showapplication.do？＆method = showApplication＆haid = 10000040

  • URL中的haid是您所需的组ID，在这种情况下为10000040。
resolvedns 该值可以是True或False。当您使用单个DNS名称配置了多个系统IP地址时，请勿解析DNS名称。
credentialID 由Applications Manager为凭证设置的唯一标识符。
label 为资源分配标签。

* 必填

以委派的管理员用户身份添加新监视器

当以委派的管理员用户身份添加新监视器时，应在API URL中附加以下参数：

字段 描述
addToGroup * 表示是否应将监视器添加到业务组。值是 true或 false。
groupID * 要添加监视器的业务组的组ID。

* 必填

示例请求

http://app-windows:9090/AppManager/AppManager/xml/AddMonitor?apikey=f746be1da5fb1a2668b00251742ccd2d&type=SilverStream&displayname=sliverstream&host=hostname&port=8081&ManagedServerID=1&addToGroup=true&groupID=10069

从企业版中的管理服务器添加新监视器

从企业版中的管理服务器添加新监视器时，用户可以选择自己喜欢的托管服务器。为此，应在API URL中附加以下参数：

字段 描述
ManagedServerID * 新的监视器将添加到指定了ID的被管服务器中。
ManagedServerGroupName * 新的监视器将添加到指定组中的被管服务器中。

*如果未指定这些参数，则将根据负载因子选择被管服务器 。

注意：

包含特殊字符（如显示名称或密码）的参数将需要HTML编码。例如，如果密码包含特殊字符，如＆，，＃，＆，％或+，则在REST API中传递密码时，应将其替换为以下相应的字符串：

  • ＃应替换为％23
  • ＆应替换为％26
  • ％应替换为％25
  • +应替换为％2B

有关HTML编码的更多信息， 请参见此处。

调用Add Monitor API将更改现有监视器的显示名称。

示例请求

本示例可帮助您将Windows服务器添加到Applications Manager：

http://app-windows:9090/AppManager/xml/AddMonitor?apikey=0b0fd47feeff9050d6a45dd7b5bb5791&type=servers&displayname=APM-Windows&host=hostname&snmptelnetport=161&os=WindowsXP&mode=SNMP&username=administrator&password=vembu&snmpCommunityString=public

示例输出

<AppManager-response uri="/AppManager/xml/AddMonitor">
   <result>
      <response response-code="4000">
         <message>Monitor added successfully.</message>
      </response>
   </result>
</AppManager-response>

示例错误

如果未正确执行API，则请求将失败，并且将引发错误，如下所示：

<Apm-response uri="/AppManager/xml/AddMonitor">
   <result>
      <response response-code="4225">
         <message>The Transaction mentioned in the request URL should be yes or no.</message>
      </response>     
    </result>
</Apm-response>

从管理服务器添加新监视器的示例

管理服务器ID:

http://app-windows:9090/AppManager/xml/AddMonitor?apikey=627b1432529fbace2867388e6abf15e&type=ms sql&displayname=mssql&username=sa&host=hostname&password=password@123&port=1433&instance=&authentication=SQL&ManagedServerID=2

管理服务器组名称:

http://app-windows:9090/AppManager/xml/AddMonitor?apikey=627bce9dvsdv0db9fbace2867388e6abf15e&type=ms sql&displayname=mssql&username=sa&host=hostname&password=password@123&port=1433&instance=&authentication=SQL&ManagedServerGroupName=WIN4

注意：有时，API执行可能会导致错误情况。如果发生错误，则将在响应正文中发送错误信息。响应主体将<error>作为子节点以及相应的错误代码。要了解有关常见错误条件列表的更多信息， 请参见此处。