跳到主要内容

SEMP API参考

您可以通过以下两种方式访问 SEMP API 参考:

  • 在可以连接到您的主机事件代理的 Web 浏览器中输入以下 URL:
http://<host>:<port>/SEMP/v2/<api>/help

其中 hostport 识别事件代理,apiconfigactionmonitor.

有关使用哪个端口的信息,请参阅默认端口号(适用于设备和软件事件代理)和客户端应用程序连接性和安全性(适用于 PubSub+ Cloud).

例如:

http://192.168.123.45:8080/SEMP/v2/monitor/help
  • 点击下面的适当链接以查看软件事件代理和事件代理服务的配置、操作或监控参考,或设备的参考.
imgimg
##### 软件事件代理和事件代理服务锚点##### 设备锚点
配置参考
操作参考
监控参考配置参考
操作参考
监控参考

云和软件事件代理的 SEMP API 参考与设备的参考之间存在一些细微差别.

SEMP OpenAPI定义

如果您想查看或下载 SEMP OpenAPI 定义文件(例如,以生成 SEMP 客户端库),请在可以连接到您的主机事件代理的 Web 浏览器中输入以下 URL:

http://<host>:<port>/SEMP/v2/<api>/spec

其中 hostport 识别事件代理,apiconfigactionmonitor.

有关使用哪个端口的信息,请参阅默认端口号(适用于设备和软件事件代理)和客户端应用程序连接性和安全性(适用于 PubSub+ Cloud).

例如:

http://192.168.123.56:8080/SEMP/v2/action/spec

从v9.6之前的版本迁移到v9.6或更高版本的swagger-codegen Java客户端代码

在版本 9.6 中,SEMP 版本 2.17 添加了一个名为 opaquePassword 的新查询参数.当使用 swagger-codegen 为该版本生成新的客户端库时,某些语言的 API 调用的方法签名可能会以不兼容的方式更改.

在从 SEMP 版本 2.17 生成的 Java 库中,所有 API 调用都有一个用于 opaquePassword 的新参数.使用新生成的库的现有代码在为这个新参数提供值之前无法编译.您必须为每个实例提供 null 值以保留现有代码的行为.

或者,为了避免对方法签名进行这些更改,您可以手动删除描述 opaquePassword 查询参数的 Swagger 规范部分.然而,在您的代码更新之前,您必须在每次升级和重新生成客户端库时进行此编辑.