• 入门
  • 告警
     
  • 可用性
     
  • 业务视图
     
  • 仪表板
     
  • 设备
     
  • 发现
  • 企业版
  • 事件
     
  •  
  • 接口
     
  • 监视器
     
  • 通知
     
  • 报表
     
  • 设置
     
  • 无线
     

OpManager REST API

OpManager提供REST api,用于从OpManager中添加和获取数据。使用这些api,您可以将OpManager与第三方IT管理/服务台软件集成。

OpManager REST API是如何工作的?

API使用API密钥。API密钥对于每个OpManager帐户是唯一的,并且对于所有API请求都是必需的。 了解如何启用或禁用Rest API密钥

如何查看API密钥?

要查看或复制API密钥,请转到OpManager Web客户端中的快速链接>Rest API Key选项。(快速链接选项是右上角的齿轮图标)

​怎样发送api密钥?

​基于请求参数的 apiKey 身份验证功能已弃用。在版本 128100 之前,可以通过 request 参数发送 apiKey。从版本 128100 开始,apiKey 现在可以在请求标头中发送,也可以作为请求参数发送。

注意: 对基于请求参数的 apiKey 身份验证的支持即将结束。以下 URL 列表应仅通过请求标头使用 apiKey 调用。基于请求参数的 ApiKey 身份验证不适用于这些 URL。

API
/api/json/alarm/listAlarms
/api/json/admin/addLinuxCredential
/api/json/discovery/addDiscoveryProfile
/api/json/discovery/editDiscoveryProfile
/api/json/v2/discovery/addDiscoveryProfile
/api/json/v2/discovery/editDiscoveryProfile
/api/json/ncmsettings/importSSHKey
/api/json/ncmsettings/importDevices
/api/json/ncmsettings/uploadConfigletFile
/api/json/ncmsettings/uploadConfigletPreView
/api/json/ncmsettings/importConfiglets
/api/json/ncmdevice/updateHostNamefromFileImp
/api/json/ncmdevice/editCustomColfromFileImp
/api/json/ncmdevice/importDG
/api/json/ipam/addSubnet
/api/json/spm/addSwitch

一个头文件的配置示例: api_header

启用/禁用 Rest API 访问

从版本 127131 开始,添加了启用/禁用 Rest API 的选项。

哪里改变了?

  • 默认情况下,对于在“用户管理”下创建的新用户,将禁用 Rest API 访问。对所有模块和设备具有完全访问权限的管理员将能够在“用户管理”下编辑用户,并在需要时提供 Rest API 访问权限。
  • enable-api-1

  • 如果已为用户启用了 RestApikey 访问,则“快速链接”下的“Rest API”菜单将显示 RestApikey,并且仅当为用户启用了 Rest API 访问时,才允许外部 Rest API 调用。
  • enable-api-2

  • 如果禁用了 Rest API 访问,则“快速链接”下的“Rest API”菜单将显示“联系管理员用户”。
  • enable-api-3

注意:

企业版用户同步: Rest API访问将不会从中心服务器同步到探针服务器。probe中的同步用户将没有永久的Rest API访问权限。然而,对于在探针服务器中创建的用户,可以根据需要更新Rest API访问。

TFA: 如果配置了双因素身份验证,则必须进行 TFA OTP 验证才能启用 Rest API 访问。

重新生成API密钥:要生成API密钥,请在OpManager Web客户端中转到设置>REST API>基本设置,然后单击重新生成密钥。

告警

可用性

业务视图

仪表板

设备

发现

企业版

事件

设置

子网

无线

Back to Top