ManageEngine® Applications Manager

Applications Manager REST API

ManageEngine Applications Manager提供可以用来从Applications Manager获取数据的REST API。使用这些API，Applications Manager的数据可集成到任何内部门户或其他第三方系统管理软件。数据可以展示在一个单独的仪表板中。

通过使用任何脚本语言的XML解析器，如果Java、C、Perl或者Python等等，你可以使用API推荐使用的HTTPs请求。数据可以插入到你自己的数据库或你要的任意格式。

前提条件

Applications Manager用户账户

每个Applications Manager用户要有一个有效的用户名（UserName）来使用API。

例如，在一个内部门户中，如果某个用户登录，只会显示关联给这个用户的监视器、告警。这样，每一个用户就要有一个单独的API。当使用某个用户的键来执行GetAlarms API时，将显示关联给那个用户的告警。

API如何工作？

为了使用API，每个用户应该获取一个API键值，这个键值是一长串字符并且每个Applications Manager账号都是不同的。API键值在每一个API请求中作为参数传递。

生成API键

用户可以使用管理页签下的“REST API”选项来注册API键。

注意: API键一次生成。

使用REST API的步骤

点击管理页签
在Applications Manager服务器设置下，点击REST API。
可以看到生成的API键。如7b5fde68148fa2419bc2f1a1ab87e757
打开浏览器，输入如下URL
http://<myappmanager-server>:9090/AppManager/xml/ListServer?apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=all
改变<type>为需要的监视器类型，将返回属于此监视器类型的的数据。检查下面的URL是否运行正常
http://<myappmanager-server>:9090/AppManager/xml/ListServer?apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=server

将返回所有服务器类型的监视器。使用'all'将返回Applications Manager的全部数据。
通过使用任何脚本语言的XML解析器，如果Java、C、Perl或者Python等。你可以使用API推荐的HTTPs请求。可以把数据插入到你数据库或其他任意格式。

API描述

REST API	描述	XSD
ListMonitor	这个API可以获取监视器的可用性、健康状况、类型和状态（管理/未管理）等。	ListMonitor.xsd
ListServer	这个API可以获取服务器的IP地址、状态、运行的服务等详细信息。	ListServer.xsd
ListAlarms	这个API客户获取告警信息。如告警状态（critical/warning/clear）、类型、告警排名和时间。	ListAlarms.xsd
Manage / UnManage	这个API可以通过ResourceID来在Applications Manager中管理或停止管理监视器。	ManageMonitor.xsd UnmanageMonitor.xsd
Authenticator	这个API允许用户使用用户名和密码获取REST-API key，但是只能在https中工作。	Authenticator.xsd
ListDashboards	这个API允许用户列出所有Applications Manager中配置的仪表板。	ListDashboards.xsd
ListMonitorTypes	这个API允许用户列出所有配置的监视器的类型和它们的详细信息。	ListMonitorTypes.xsd
ListMonitorGroups	这个API允许用户列出所有的业务组以及它们的基本信息。	ListMonitorGroups.xsd
ListMGDetails	这个API允许用户获取关于业务组的信息，如关联的监视器、子组等。	ListMGDetails.xsd
ListActions	这个API允许用户获取为监视器配置的动作列表。	ListActions.xsd
ExecuteAction	这个API允许用户执行一个指定的动作。	ExecuteAction.xsd
Search	这个API允许用户获取符合搜索条目的监视器列表。	Search.xsd
ShowPolledData	这个API允许用户获取轮询的数据或基于请求参数“period”获取归档的数据。	ShowPolledData.xsd
Ping	这个API允许用户从Applications Manager服务器Ping监视器或主机。	Ping.xsd
CreateMaintenanceTask	这个API可以创建一个停机计划。	CreateMaintenanceTask.xsd
EditMaintenanceTask	这个API可以编辑一个停机计划。	EditMaintenanceTask.xsd
DeleteMaintenanceTask	这个API可以删除一个停机计划。	DeleteMaintenanceTask.xsd
GetMonitorData/ListMonitorData	这个API可以获取监视器的最后一次轮询数据。	ListMonitorData.xsd
AddMonitor	这个API可以在Applications Manager中添加监视	AddMonitor.xsd
ListMaintenanceTaskDetails	这个API可以列出所有的停机计划。	ListMaintenanceTaskDetails.xsd
AddMonitorGroup	这个API可以添加新的业务组。	AddMonitorGroup.xsd
PollNow	这个API可以轮询监视器。	PollNow.xsd
DeleteMonitor	这个API可以删除监视器。	DeleteMonitor.xsd

说明： 你可以通过执行ListMonitor API 来请求获得一个监控器的resourceid。这个要求的输出resourceid包含监控信息的值。REST API xsd文件位于 AppManager9/help/RESTAPI/xsd文件夹下。

<< 上一页	主页	下一页 >>
产品环境		添加监视器API