OpUtils API

• 概述
• API的使用
• 生成API密钥
• 支持的输出格式
• 支持的模块

概述

OpUtils提供的应用编程接口(API)，允许您通过编程访问OpUtils使用的数据库，获取所需要的信息。您不必了解数据库的结构以及数据库表之间的关系，即可方便地得到想要的信息。有了API，可以：

• 获取OPUtils中的信息，以便用于其它应用之中，方便与第三方应用的集成。
• 与其它第三方报表工具集成，创建自定义报表
• 不需要了解具体的数据库结构，即可达到信息共享的目的。

API的使用

通过URL调用OpUtils API，获取所需的信息。URL的构造如下：

http://<oputils_server_name_or_ip>:<port_number>/oputilsapi/<api_version>/<oputils_module>?key=<api_key>&operation=<operation_name>&<operation_parameters>&format=<output_format>

这里,

<oputils_server_name_or_ip> 代表运行OpUtils机器的DNS名称或者IP地址。

<port_number> 代表 OpUtils 的运行端口，默认是：7080

<api_version> 代表OpUtils API的版本，当前版本为：v1

<oputils_module> 代表使用API要获取信息的OpUtils模块。目前支持的模块，可参照支持的OpUtils模块。

<api_key> 代表查询认证用的API密钥，每个OpUtils用户都有唯一的密钥，可按照这里指定的步骤，生成密钥。

<operation_name> 代表用来获取信息的 API操作。不同数据类型及模块，其操作名称也不同。 具体的操作及参数请参照相应的文档。

<operation_parameters> 代表操作时使用的参数或者变量。并不是每个操作都需要指定参数，具体情况请参照相应的文档。

<output_format> 代表操作所返回结果的格式，详情可参照支持的输出格式。

例如: http://oputils-test1:7080/oputilsapi/v1/ipam?key=27559d9f-9866-411e-a71b-c44c2a04f299&operation=GET_SUBNET_SUMMARY&subnetAddress=192.168.118.0&format=xml

生成API密钥

API 密钥用于验证或认证某个API请求是有效的OpUtils的用户所做，以防止非法请求进入。对于OpUtils的每个用户，都有唯一的密钥。可以使用多个用户的密钥进行API操作。

生成API密钥的步骤如下：

1. 从OpUtils的Web客户端，点击 管理 --> 用户管理，它将列出所有用户的明细。
2. 从列表中选择要生成API密钥的用户，点击该用户动作栏下的 图标，打开生成API密钥的对话框，在对话框中指定密钥的有效期。
3. 点击 生成API密钥按钮，生成的密钥显示在此对话框中，您需要复制它，并将其保存在安全的地方，以便在调用API时使用。

支持的输出格式

目前API查询的输出格式支持XML格式。

支持的模块

OpUtils API目前支持以下模块：

• IP地址管理 - 您应该在您的URL中使用 'ipam' 作为模块名称。