创建或更新协议插件

作用

URI

使用具有以下 IBM® IoT MessageSight 配置 URI 的 IBM IoT MessageSight REST API POST 方法：

http://<admin-endpoint-IP:Port>/ima/v1/configuration/

对象配置数据

使用以下模式在 POST 方法的有效内容中提供 ProtocolPlugin 对象配置数据。Content-type 设置为 application/json：

{    
  "Plugin": {
    "<NameOfPlugin>": {
      "File": "string",
      "PropertiesFile": "string",
      "Overwrite": true|false
      }
   }
}

NameOfPlugin

这是必需属性。

指定插件的名称。

名称必须与插件配置文件中的 Name 参数值匹配。

名称的最大长度为 256 个字符。

File

在创建或更新协议插件时为必需项；否则为可选项。

指定已使用 IBM IoT MessageSight REST API PUT 方法上载的插件 .zip 文件的名称。

插件 .zip 文件名的最大长度为 255 个字符。

PropertiesFile

在更新协议插件属性文件时为必需项；否则为可选项。

指定要与插件相关联的协议插件属性文件名称。您可以开发 JSON 格式的属性文件，该文件包含的属性将覆盖插件配置文件中的任何属性。

协议插件属性文件名的最大长度为 255 个字符。

Overwrite: true|false

指定在插件具有相同名称时，是否覆盖现有插件。

缺省值为 false，表示在同名的情况下不覆盖现有的插件。

用法说明

• 必须按照所示情况使用首字母大写和双引号。
• 在创建协议插件之前，必须上载插件 .zip 文件。将本地计算机中的文件复制到 IBM IoT MessageSight 以上载协议插件。
• 在创建协议插件之后，必须重新启动协议插件服务器。只有在重新启动协议插件服务器后，插件安装才会生效。
• 可以随时更新插件。必须指定 "Overwrite":true 才能更新现有插件。只有在重新启动插件服务器后，更新才会生效。

相关的 REST 管理 API

• 将本地计算机中的文件复制到 IBM IoT MessageSight
• 重新启动协议插件服务器进程
• 启动协议插件服务器进程
• 停止协议插件服务器进程
• 显示协议插件服务器进程的状态
• 显示协议插件
• 显示协议及其允许的操作

示例

  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "Plugin": {
            "json_msg": {
             "File": "jsonmsg.zip"
            }
         }
       }
 '  \
http://127.0.0.1:9089/ima/v1/configuration/

{        
  "Version": "v1",
  "Code": "CWLNA6011",
  "Message": "The requested configuration change has completed successfully."
}