告警

listAlarms

方法: GET

说明: 此 API 用于列出所有告警

示例 URL: https://localhost:8060/api/json/alarm/listAlarms?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName
告警所属设备名称
severity
告警严重性
category
告警所属设备类别
period
需要列出告警的时间范围
entity
告警实体标识
alarmCode
告警代码
eventType
告警事件类型

alarmProperties

方法: GET

说明: 列出指定告警的属性

示例 URL: https://localhost:8060/api/json/alarm/alarmProperties?apiKey=***************&entity=10.59.3.196_Poll

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
entity
告警实体标识
alarmSpecific
布尔值,用于指明是否为特定告警属性。
deviceID
告警的 MOID

addNotes

方法: POST

说明: 此 API 用于为告警添加备注

示例 URL: https://localhost:8060/api/json/alarm/addNotes?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
entity*
告警实体标识
notes
要添加的备注内容描述
type
用于表明是对单个还是多个告警进行操作

acknowledgeAlarm

方法: POST

说明: 此 API 用于确认一个告警

示例 URL: https://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
entity*
告警实体标识
type
用于表明是对单个还是多个告警进行操作

unAcknowledgeAlarm

方法: POST

说明: 此 API 用于取消对告警的确认

示例 URL: https://localhost:8060/api/json/alarm/unAcknowledgeAlarm?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
entity*
告警实体标识
type
用于表明是对单个还是多个告警进行操作

clearAlarm

方法: POST

说明: 此 API 用于清除一个告警。

示例 URL: https://localhost:8060/api/json/alarm/clearAlarm?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
entity*
告警实体标识
type
用于表明是选择单个告警还是多个告警

deleteAlarm

方法: POST

说明: 此 API 用于删除一个告警

示例 URL: https://localhost:8060/api/json/alarm/deleteAlarm?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
entity*
告警实体标识
type
用于表明选择的是单个告警还是多个告警

getTopDevicesByAlarms

方法: GET

说明: 此 API 用于根据设备获取告警信息

示例 URL: https://localhost:8060/api/json/alarm/getTopDevicesByAlarms?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
eventType*
告警的事件类型

getAnnotation

方法: GET

说明: 此 API 用于获取告警的备注信息

示例 URL: https://localhost:8060/api/json/alarm/getAnnotation?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
entity*
告警实体标识

可用性

getPingResponse

方法: GET

说明: 获取指定设备的 ICMP/Ping 响应。

示例 URL: https://localhost:8060/api/json/device/getPingResponse?apiKey=***************&deviceName=<ip_address_1>

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
设备名称——在设备快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值。

getTraceResponse

方法: GET

说明: 获取指定设备的 trace route 命令响应

示例 URL: https://localhost:8060/api/json/device/getTraceResponse?apiKey=***************&deviceName=<ip_address_1>

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
设备名称——在设备快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值。

getDownDevices

方法: GET

说明: 列出当前处于宕机状态且设备状态为“critical”的设备

示例 URL: https://localhost:8060/api/json/discovery/getDownDevices?apiKey=******************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

getAvailabilityGraphData

方法: GET

说明: 获取指定设备或接口的可用性图表数据。

示例 URL: https://localhost:8060/api/json/device/getAvailabilityGraphData?apiKey=******************&isFluidic=true&name=opmServer.mydomain.com

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
name*
设备或接口名称——在设备/接口快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值,或 listInterfaces API 响应中的 'interfaceName' 属性值 [示例:opmServer.mydomain.com 或 IF-<ip_address_3>-115]
instance
如果为接口请求可用性图表,则设置 instance=Interface。若获取接口数据,此字段必填。本 API 也可用于获取其他监视器的可用性。[示例:Interface|URL|winService|service|process]
isFluidic*
默认设置为 TRUE(内部用途)

listDownTimeSchedules

方法: GET

说明: 提供在 OpManager 中创建的停机时间计划列表。

示例 URL: https://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=****************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

setManaged

方法: POST

说明: 管理或取消管理当前已在 OpManager 中添加的设备、接口或 URL 监视器。

示例 URL: https://localhost:8060/api/json/device/setManaged?manage=true&apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
manage*
如果 manage=true,则启用对设备或接口的监控;若 manage=false,则禁用监控
name*
设备或接口名称。(在设备/接口快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值)
type
若受管实体为接口,则将 type 设为 'INTERFACE'。若为 URL 监视器,则将 type 设为 'URL'。
isInterface
仅当 type 参数为 'INTERFACE' 时生效。若受管实体为接口,将此参数设为 'true'。默认情况下实体被视为设备,因此管理设备时不必传递此参数。

业务视图

getBusinessView

方法: GET

说明: 列出在 OpManager 中创建的所有业务视图。

示例 URL: https://localhost:8060/api/json/businessview/getBusinessView?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

getBusinessDetailsView

方法: GET

说明: 列出指定业务视图中的所有设备

示例 URL: https://localhost:8060/api/json/businessview/getBusinessDetailsView?apiKey=***************&bvName=ProductionSite_bv

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
bvName*
业务视图名称,后缀带有 '_bv'

仪表板

getWidgetData

方法: GET

说明: 此 API 用于获取指定小部件 ID 所需加载的数据。

示例 URL: https://localhost:8060/api/json/dashboard/getWidgetData?apiKey=***************&widgetID=495

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
widgetID*
要获取数据的小部件 ID。
widgetName
小部件名称。
WidgetID
要获取数据的小部件 ID。
widgetType
小部件类型。

getWidgetsList

方法: GET

说明: 此 API 用于列出指定仪表板中要加载的小部件。

示例 URL: https://localhost:8060/api/json/dashboard/getWidgetsList?apiKey=***************&dashboardName=dashboardname

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
dashboardName*
仪表板名称。

设备

listDevices

方法: GET

说明: 列出在 OpManager 中添加的所有设备。

示例 URL: https://localhost:8060/api/json/device/listDevices?apiKey=****************&

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
isFluidic
默认设置为 'true'。(内部用途)
type
获取属于指定设备类型的设备列表。[示例:type=Cisco2081]
category
获取属于指定设备类别的设备列表 [示例:Server、Switch 等]
app
获取安装并在 OpManager 中监控指定应用程序的设备列表 [示例:MSSQL、Exchange、Domain Controller]
bvName
获取位于指定业务视图地图下的设备列表
vendor
获取具有指定厂商名称的设备列表。
protocol
按协议筛选设备 [示例:all|SNMP|WMI|CLI|VIWebService|VIWMI|CLI|XenService|PrismAPI|NetAppAPI|SMI]
severity
按严重性筛选设备 [示例:1(Critical),2(Trouble),3(Attention),4(service down),5(Clear),7(Unmanaged)]
selectedVTypes
按虚拟设备类型筛选设备 [示例:VMware-VM|VMware-Host|HyperV-VM|Xen-VM|VMware-vCenter|Xen-Host|HyperV-Host]
groupName
按组名称筛选设备
customFields
用于获取与设备关联的自定义字段值。如果使用适用于 12.x 以上版本 OpManager 的 v2 API,则设为 'true'。[示例:/api/json/v2/device/listDevices]
getInterfaces
用于获取带有关联接口的设备。布尔值:TRUE/FALSE
page
批量获取设备列表。应与 'rows' 参数一起使用。[示例:page=1, rows=200;page=2, rows=200]
rows
批量获取设备列表。应与 'page' 参数一起使用 [示例:page=1, rows=200;page=2, rows=200]
sortByType
定义排序方式为升序或降序 [示例:sortByType=asc 或 sortByType=desc]
sortByColumn
按照指定列对设备列表进行排序 [示例:displayName、interfaceCount、ipaddress、type 等]

getDeviceNotes

方法: GET

说明: 提供与指定设备关联的自定义字段值,如楼宇、机柜、序列号等。

示例 URL: https://localhost:8060/api/json/device/getDeviceNotes?apiKey=***************&name=<ip_address_4>

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
name*
设备名称——在设备快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值。

getInfrastructureDetailsView

方法: GET

说明: 按类别提供设备的详细信息,如设备名称、显示名称、状态、IP 地址、设备类型以及关联性能监视器的值。

示例 URL: https://localhost:8060/api/json/discovery/getInfrastructureDetailsView?apiKey=**************&categoryName=Server

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
categoryName*
设备类别名称。[示例:Server、Desktop 等]

getDeviceSummary

方法: GET

说明: 提供与设备快照页面中相同的设备详情

示例 URL: https://localhost:8060/api/json/device/getDeviceSummary?apiKey=**************&name=opmServer.testdomain.com

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
name*
设备名称——在设备快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值。
isFluidic
默认设置为 TRUE。(内部用途)
snapType
设备快照类型。如果设备仅在 OpManager 中监控,设为 'MonitoringDevice'。如果已为该设备启用流量监控,则设为 'FlowDevice'
routerID
当 snapType 设置为 'FlowDevice' 时,为该设备的 router ID。

虚拟设备

listVirtualDevices

方法: GET

说明: 列出所选虚拟类型的所有实体。

示例 URL: https://localhost:8060/api/json/device/listVirtualDevices?apiKey=***************&virtualDeviceType=VM

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
virtualDeviceType*
要列出的虚拟实体类型。(允许值:VHOST、VDATASTORE、VM、VCENTER、HyperV-Host、HyperV-VM、HyperV-Disk、Xen-Host、Xen-VM、Xen-SR、Xen-Pool、Nutanix-Cluster、Nutanix-Host、Nutanix-VM)

设备快照

getDeviceCompleteDetails

方法: GET

说明: 列出设备的基本信息和可用性

示例 URL: https://localhost:8060/api/json/v2/device/getDeviceCompleteDetails?apiKey=***************&name=devicename

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
name*
设备名称

发现

addDevice

方法: POST

说明: 允许您将单个设备添加到 OpManager 进行监控。

示例 URL: https://localhost:8060/api/json/discovery/addDevice?apiKey=***************&name=opmServer.mydomain.com

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
设备的主机名、FQDN 名称或 IP 地址
credentialName
用于访问设备以获取设备信息的凭据名称。

企业版

listProbes

方法: GET

说明: 此 API 用于列出所有探针

示例 URL: https://localhost:8060/api/json/alarm/listProbes?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
toShow
用于筛选探针列表的参数:
all - 列出所有探针
up - 列出所有活动探针
down - 列出所有非活动探针
注意:取值区分大小写

事件

listEvents

方法: GET

说明: L列出事件历史。

示例 URL: https://localhost:8060/api/json/events/listEvents?apiKey=***************&deviceName=opmrouter

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName
要列出其事件的设备名称
entity
事件实体标识
period
需要列出事件的时间范围
severity
告警严重性
category
告警所属设备类别
eventType
告警事件类型

listAllLogicalGroups

方法: GET

说明: 列出 OpManager 中的所有组。同时提供各组的基本信息,如成员数量和组运行状况。

示例 URL: https://localhost:8060/api/json/admin/listAllLogicalGroups?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

getLogicalGroupInfo

方法: GET

说明: 提供指定组的详细信息(如成员数量、组状态等)。

示例 URL: https://localhost:8060/api/json/admin/getLogicalGroupInfo?apiKey=***************&groupName=NorthBayRegion-4201&period=3&snapType=LogicalDeviceGroup

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
groupName*
组名称,后缀附带 MOID,例如 <groupname>- <moid>
period
需要获取可用性数据的时间范围。[示例:twelvehours(16),Today(6),twfourhours(3),Yesterday(7),thisweek(8),Last_7_Days(4),lastweek(9),thismonth(10),Last_30_Days(5),Last_Month(11),custom(23)]
snapType
组快照类型。[示例:LogicalGroup|LogicalIntfGroup|LogicalDeviceGroup]

getLogicalGroupAlerts

方法: GET

说明: 获取由指定组成员(设备/接口)产生的告警。

示例 URL: https://localhost:8060/api/json/admin/getLogicalGroupAlerts?apiKey=***************&groupName=bvgcty-4201

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
groupName
组名称

listLogicalGroupMembers

方法: GET

说明: 提供指定组内成员的信息。

示例 URL: https://localhost:8060/api/json/admin/listLogicalGroupMembers?apiKey=***************&groupName=NorthBayRegion-4201

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
groupName
设备/接口组名称,后缀为 '- <moid>'。[示例:<groupname>- <moid>]

addToGroup

方法: POST

说明: 允许您将设备添加到指定组。

示例 URL: https://localhost:8060/api/json/device/addToGroup?apiKey=***************&groupType=device&selectedMembers=<ip_address_5>,opmServer

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
groupName*
设备/接口组名称,后缀包含 MOID。[示例:<groupname>- <moid>]
groupType*
组类型 [示例:device|interface]
selectedMembers*
设备名称列表,以逗号分隔。设备名称为设备快照页面 URL 中的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值

接口

listInterfaces

方法: GET

说明: 列出在 OpManager 中监控的所有接口

示例 URL: https://localhost:8060/api/json/device/listInterfaces?apiKey=***************&isFluidic=true&rows=100&page=1&sortByColumn=statusNum&sortByType=desc

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
isFluidic
默认设置为 'true'(内部用途)
rows
批量获取接口列表。应与 'page' 参数一起使用 [示例:page=1, rows=200;page=2, rows=200]
page
批量获取接口列表。应与 'rows' 参数一起使用 [示例:page=1, rows=200;page=2, rows=200]
sortByColumn
按照指定列对接口列表排序 [示例:inSpeed、displayName、ipaddress、outSpeed、statusNum、severity - 1(Critical),2(Trouble),3(Attention),4(service down),5(Clear),7(Unmanaged)]
sortByType
定义接口列表的升序或降序排序 [示例:sortByType=asc 或 sortByType=desc]
severity
按严重性筛选接口。[示例:1(Critical),2(Trouble),3(Attention),4(service down),5(Clear),7(Unmanaged)]
type
按接口类型筛选接口。[示例:Ethernet、Software Loopback 等]
intfProps
获取额外的接口属性,如 ifName(接口 ifName)、moid(接口/设备使用的内部受管对象标识)、physAddress

getInterfaceSummary

方法: GET

说明: 提供接口的基本信息,如 ifIndex、ifName、ifDesc、ifAlias、父设备、Rx/Tx 流量等。

示例 URL: https://localhost:8060/api/json/device/getInterfaceSummary?apiKey=***************&interfaceName=IF-<ip_address_6>-4429

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
interfaceName*
接口的 ManagedObject 名称,可在接口快照页面 URL 中看到。

getIntfAtAGlanceReportDetails

方法: GET

说明: 为指定接口提供汇总的可用性及性能监控运行状况报表数据。

示例 URL: https://localhost:8060/api/json/v2/device/getIntfAtAGlanceReportDetails?apiKey=***************&InterfaceName=IF-<ip_address_1>-3820&period=Today

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
InterfaceName*
接口名称——在接口快照页面 URL 中看到的受管实体名称,或 listInterfaces API 响应中的 'interfaceName' 属性值。
period*
需要获取接口数据的时间范围。[示例:twelvehours,Today,twfourhours,Yesterday,thisweek,Last_7_Days,lastweek,thismonth,Last_30_Days,Last_Month,custom]
startDate
起始日期。仅在 period 参数值选择 'custom' 时适用
endDate
结束日期。仅在 period 参数值选择 'custom' 时适用

getIntfBWOutageReportDetails

方法: GET

说明: 为指定接口提供汇总带宽报表数据(Rx/Tx 流量)。

示例 URL: https://localhost:8060/api/json/v2/device/getIntfBWOutageReportDetails?apiKey=***************&interfaceName=IF-<ip_address_1>-3836&period=Today

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
interfaceName*
接口名称——在接口快照页面 URL 中看到的受管实体名称,或 listInterfaces API 响应中的 'interfaceName' 属性值
period*
需要获取接口图表的时间范围。[示例:twelvehours,Today,twfourhours,Yesterday,thisweek,Last_7_Days,lastweek,thismonth,Last_30_Days,Last_Month,custom]
startDate
起始日期。仅在 period 参数值选择 'custom' 时适用
endDate
结束日期。仅在 period 参数值选择 'custom' 时适用

getInterfaces

方法: GET

说明: 提供某设备上被监控接口的列表。

示例 URL: https://localhost:8060/api/json/device/getInterfaces?apiKey=***************&name=opmServer.testdomain.com

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
name*
父设备名称——在设备快照页面 URL 中的父设备受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值

getInterfaceNotes

方法: GET

说明: 获取与指定接口关联的自定义字段值。

示例 URL: https://opmServer:8060/api/json/device/getInterfaceNotes?apiKey=************&interfaceName=IF-opmServer.testdomain.com-4505

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
interfaceName*
接口名称——在接口快照页面 URL 中看到的受管实体名称,或 listInterfaces API 响应中的 'interfaceName' 属性值

getInterfaceGraphs

方法: GET

说明: 获取指定接口采集的数据(如流量、错误与丢弃等)。

示例 URL: https://localhost:8060/api/json/device/getInterfaceGraphs?apiKey=***************&interfaceName=IF-<ip_address_4>06-329&graphName=rxutilization

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
interfaceName*
接口名称——在接口快照页面 URL 中看到的受管实体名称,或 listInterfaces API 响应中的 'interfaceName' 属性值
graphName
接口图表名称 [示例:totalPackets|traffic|utilization|errors|discardRate|packets|errorRate]
isFluidic
默认设置为 'true'(内部用途)
period
需要获取接口图表的时间范围。[示例:twelvehours(16),Today(6),twfourhours(3),Yesterday(7),thisweek(8),Last_7_Days(4),lastweek(9),thismonth(10),Last_30_Days(5),Last_Month(11),custom(23)]
startDate
起始日期。仅在 period 参数值选择 'custom' 时适用
endDate
结束日期。仅在 period 参数值选择 'custom' 时适用

监控

getDeviceAssociatedMonitors

方法: GET

说明: 列出与设备关联的所有监视器

示例 URL: https://localhost:8060/api/json/device/getDeviceAssociatedMonitors?apiKey=***************&name=devicename

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
name*
设备名称

性能监视器

getPerformanceMonitors

方法: GET

说明: 列出针对特定设备可用的所有性能监视器(基于设备的类别和类型)

示例 URL: https://localhost:8060/api/json/device/getPerformanceMonitors?apiKey=***************&deviceName=devicename&category=Desktop&type=Windows 2008 R2

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
设备名称
category*
设备类别
type*
设备类型

getPerfomanceMonitorDetails

方法: GET

说明: 列出某设备上已关联性能监视器的详细信息

示例 URL: https://localhost:8060/api/json/device/getPerfomanceMonitorDetails?apiKey=***************&name=devicename&policyName=WMI-CPUUtilization&graphName=WMI-CPUUtilization&checkNumeric=true

参数名称
说明
备注
apiKey*
访问 OpManager Server 的 API 密钥。
-
name*
设备名称
-
policyName*
性能监视器的策略名称
-
graphName*
性能监视器的图表名称。
“policyName”和“graphName”值可通过 getDeviceAssociatedMonitors API 获取
checkNumeric*
true 或 false。
-

addPerfomanceMonitors

方法: POST

说明: 向设备添加一个或多个性能监视器

示例 URL: https://localhost:8060/api/json/device/addPerfomanceMonitors?apiKey=***************&name=devicename&selectedMonitors=1166,3337,304,204,205,203,3327

参数名称
说明
备注
apiKey*
访问 OpManager Server 的 API 密钥。
-
name*
设备名称
-
selectedMonitors*
要添加的性能监视器图表 ID(多个值用逗号分隔)。
GraphID 值可通过 getPerformanceMonitors API 获取

deletePerfomanceMonitors

方法: POST

说明: 从设备中删除性能监视器

示例 URL: https://localhost:8060/api/json/device/deletePerfomanceMonitors?apiKey=***************&name=devicename&pollId=332,213

参数名称
说明
备注
apiKey*
访问 OpManager Server 的 API 密钥。
-
name*
设备名称
-
pollId*
性能监视器的 pollId(多个值用逗号分隔)。
pollId 值可通过 getDeviceAssociatedMonitors API 获取

TestMonitor

方法: POST

说明: 在指定设备上测试性能监视器

示例 URL: https://localhost:8060/api/json/device/TestMonitor?apiKey=***************&name=devicename&policyName=WMI-MemoryUtilization&graphName=WMI-MemoryUtilization

参数名称
说明
备注
apiKey*
访问 OpManager Server 的 API 密钥。
-
name*
设备名称
-
policyName*
监视器的策略名称
-
graphName*
监视器的图表名称。
“policyName”和“graphName”值可通过 getDeviceAssociatedMonitors API 获取
instanceName
实例名称(仅适用于 MSSQL 监视器)。
-

进程监视器

getAssociatedProcessMonitors

方法: GET

说明: 获取已关联到某设备的进程监视器列表

示例 URL: https://localhost:8060/api/json/device/getAssociatedProcessMonitors?apiKey=***************&deviceName=devicename

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
设备名称

associateProcessMonitor

方法: POST

说明: 将进程监视器关联到设备

示例 URL: https://localhost:8060/api/json/device/associateProcessMonitor?apiKey=***************&deviceName=devicename&processId=408,8,68&protocol=WMI

参数名称
说明
备注
apiKey*
访问 OpManager Server 的 API 密钥。
-
deviceName*
设备名称。
-
processId*
需要关联的进程 ID
processId 值可通过 getAssociatedProcessMonitors API 获取

服务监视器

getAssociatedServiceMonitors

方法: GET

说明: 获取已关联到设备的服务监视器列表

示例 URL: https://localhost:8060/api/json/device/getAssociatedServiceMonitors?apiKey=***************&name=devicename

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
name*
设备名称

associateServiceMonitor

方法: POST

说明: 将服务监视器关联到设备

示例 URL: https://localhost:8060/api/json/admin/associateServiceMonitor?apiKey=***************&deviceName=devicename&serviceName=DNS,FTP,Echo

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
需要关联服务的设备名称。多个设备名称可用逗号分隔以进行批量关联
serviceName*
服务名称(多个值用逗号分隔)。

Windows 服务监视器

getDeviceAssociatedWindowsServiceMonitors

方法: GET

说明: 列出与某设备关联的 Windows 服务监视器

示例 URL: https://localhost:8060/api/json/device/getDeviceAssociatedWindowsServiceMonitors?apiKey=***************&name=devicename

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
name*
设备名称

URL 监视器

listURLMonitors

方法: GET

说明: 列出 OpManager 中所有全局 URL 监视器

示例 URL: https://localhost:8060/api/json/admin/listURLMonitors?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

脚本监视器

listScriptMonitors

方法: GET

说明: 列出 OpManager 中所有脚本模板

示例 URL: https://localhost:8060/api/json/admin/listScriptMonitors?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

通知

listNotificationProfiles

方法: GET

说明: 此 API 用于列出在 OpManager 中创建的所有通知配置文件。

示例 URL: https://localhost:8060/api/json/admin/listNotificationProfiles?apiKey=***************&isGlobal=true&profileFilter=All&deviceName=devicename

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
isGlobal
false - 表示按设备特定配置文件进行筛选。
profileFilter
All - 用于显示全局配置文件以及其他类型的配置文件(Send+Email、Send+SMS、Send+Modem+SMS、Run+System+Command 等)
deviceName
要关联的设备名称

associateNotificationProfiles

方法: POST

说明: 此 API 用于将通知配置文件关联到设备。

示例 URL: https://localhost:8060/api/json/admin/associateNotificationProfiles?apiKey=***************&deviceName=devicename&profiles=501

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
要关联的设备名称
profiles*
要关联的配置文件 ID。

报表

getReportsList

方法: GET

说明: 此 API 用于列出所有报表

示例 URL: https://localhost:8060/api/json/reports/getReportsList?apiKey=***************&isFavouriteNeeded=true&hideintegratedReports=true&hideHardwareReport=true

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
isFavouriteNeeded
布尔值,用于是否显示收藏报表。
hideintegratedReports
布尔值,用于是否显示集成报表。
hideHardwareReport
布尔值,用于是否显示硬件报表。

getReportsData

方法: GET

说明: 用于获取所需报表数据的 API。

示例 URL: https://localhost:8060/api/json/reports/getReportsData?apiKey=***************&reportID=84&isExcludeDays=true&excludedDays=Monday,Tuesday&category=Desktop&bview=All&time=Last_Month&timeWindow=8-20&isBusinessHour=false&showType=0&top=1000&viewAs=json

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
reportID
单个报表的唯一 ID。
viewAs
查看报表结果数据的格式。
time
获取报表数据的时间范围。
isExcludeDays
布尔值,用于是否排除某些日期。
excludedDays
在报表数据中要排除的日期。
category
查看报表数据的设备类别。
logicalGroup
查看报表数据的逻辑组。
bview
查看报表数据的业务视图。
timeWindow
获取报表数据的时间窗口。
showType
显示报表数据前 N 或后 N 条内容。
top
显示报表数据前 N 条记录。
startTime
自定义时间段的开始时间。
endTime
自定义时间段的结束时间。
startHour
自定义时间段的开始小时。
endHour
自定义时间段的结束小时。
customerId
要筛选的探针 ID。
customerName
要筛选的探针名称。
fromEmailid
发送报表的发件人邮箱 ID。
toEmailid
接收报表的收件人邮箱 ID。
emailSubject
邮件主题
isBusinessHour
布尔值,是否仅显示工作时间数据。
businessRuleID
此前创建的业务规则 ID。

listBusinessRules

方法: GET

说明: (待补充)

示例 URL: https://localhost:8060//api/json/admin/listBusinessRules?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

addBusinessRules

方法: POST

说明: 此 API 用于配置从周一到周日的工作时间规则。

示例 URL: https://localhost:8060/api/json/admin/addBusinessRules?apiKey=***************&businessRuleName=Rule1&description=Indian standard time shift 1.&timeSettings={"monday":"1-5","tuesday":"3-6","wednesday":"3-5","thursday":"2-5","friday":"5-13"}

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
description
业务规则说明。
businessRuleName
工作时间规则名称。
timeSettings
从周一到周日的时间配置。

deleteBusinessRules

方法: POST

说明: 此 API 用于删除已创建的工作时间规则。

示例 URL: https://localhost:8060//api/json/admin/deleteBusinessRules?apiKey=***************&businessRuleId=1

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
businessRuleId
工作时间规则 ID。

viewBusinessRules

方法: GET

说明: 此 API 用于查看已创建的工作时间规则。

示例 URL: https://localhost:8060//api/json/admin/viewBusinessRules?apiKey=***************&businessRuleId=1

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
businessRuleId
工作时间规则 ID。

updateBusinessRules

方法: POST

说明: 此 API 用于配置从周一到周日的工作时间规则。

示例 URL: https://localhost:8060/api/json/admin/updateBusinessRules?apiKey=***************&businessRuleName=Rule1&description=Indian standard time shift 1.&timeSettings={"monday":"1-5","tuesday":"3-6","wednesday":"3-5","thursday":"2-5","friday":"5-13"}&businessRuleId=1

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
description
业务规则说明。
businessRuleName
工作时间规则名称。
timeSettings
从周一到周日的时间配置。
businessRuleId
工作时间规则 ID。

getReportData

方法: POST

说明: 此 API 用于获取报表数据。

示例 URL: https://localhost:8060//api/json/admin/getReportData?apiKey=***************&deviceList=hari-8348.csez.zohocorpin.com,<phone_number_5>.1.1&monitorList=DevicesAvailability,ResponseTime,WMI-CPUUtilization,MSSQLDataFilesSizeKB&timePeriod=Last_Month&view=table&timeWindow=0-24&startDate=2020-11-09&endDate=2020-11-18

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceList
需要获取报表数据的设备列表。
monitorList
需要获取报表数据的监视器列表。
timePeriod
获取报表数据的时间范围。
view
以表格/图形格式查看报表。
tableView
用于按实例/监视器显示报表数据。
combinedTable
布尔值,用于是否以合并表格显示结果。
startDate
报表数据的开始日期。
endDate
报表数据的结束日期。
startHour
报表数据的开始小时。
endHour
报表数据的结束小时。
timeWindow
获取报表数据的时间窗口。

listAllAdvancedReports

方法: GET

说明: (待补充)

示例 URL: https://localhost:8060//api/json/admin/listAllAdvancedReports?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

设置

设备类别

getCategoryList

方法: POST

说明: 列出所有可用的设备类别

示例 URL: https://localhost:8060/api/json/device/getCategoryList?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

子网

listSubnets

方法: GET

说明: 列出在 OpManager 中监控的所有子网

示例 URL: https://localhost:8060/api/json/device/listSubnets?apiKey=***************

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。

无线

getWirelessNetworkDetails

方法: GET

说明: 为每个 WLC(无线局域网控制器)中的 SSID 列出接入点数量、客户端数量和网络使用情况

示例 URL: https://localhost:8060/api/json/wireless/getWirelessNetworkDetails?apiKey=***************&deviceName=CiscoWirelessController

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
WLC 设备名称(在设备快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值)

getWirelessAPList

方法: GET

说明: 列出 WLC 设备中的所有接入点。

示例 URL: https://localhost:8060/api/json/wireless/getWirelessAPList?apiKey=***************&deviceName=CiscoWirelessController

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
WLC 设备名称(在设备快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值)

getSSIDClientList

方法: GET

说明: 列出与指定 WLC 设备关联的所有 SSID 客户端。

示例 URL: https://localhost:8060/api/json/wireless/getSSIDClientList?apiKey=***************&deviceName=CiscoWirelessController

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
WLC 设备名称(在设备快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值)

getClientDetails

方法: GET

说明: 获取连接到指定 WLC 设备的某个 SSID 的客户端设备信息。

示例 URL: https://localhost:8060/api/json/wireless/getClientDetails?apiKey=***************&deviceName=CiscoWirelessController&ssidName=WorkstationNetwork

参数名称
说明
apiKey*
访问 OpManager Server 的 API 密钥。
deviceName*
WLC 设备名称(在设备快照页面 URL 中看到的受管实体名称,或 listDevices API 响应中的 'deviceName' 属性值)
ssidName*
与 WLC 关联的无线网络 SSID 名称