更新协议插件属性文件

作用

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>": {
      "PropertiesFile": "string",
      "Overwrite": true|false
      }
   }
}

NameOfPlugin

这是必需属性。

指定与属性文件相关联的协议插件的名称。如果此名称存在，那么可以在 plugin.json 配置文件中找到此名称。

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

PropertiesFile

这是必需属性。

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

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

Overwrite: true|false

在已经安装了协议插件时为必需项。

指定是否覆盖具有相同名称的任何现有协议属性文件。

缺省值为 false。

用法说明

• 必须按照所示情况使用首字母大写和双引号。
• 可以随时更新插件。
• 必须指定 "Overwrite":true 才能更新现有插件。
• 只有在重新启动插件服务器后，更新才会生效。

相关的 REST 管理 API

• 重新启动协议插件服务器进程
• 启动协议插件服务器进程
• 停止协议插件服务器进程
• 显示协议插件服务器进程的状态

示例

  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "Plugin": {
            "json_msg": {
             "PropertiesFile": "pluginprops.json",
             "Overwrite": true          
            }
         }
       }
 '  \
http://127.0.0.1:9089/ima/v1/configuration/

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