创建或更新 LTPA 概要文件

作用

URI

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

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

对象配置数据

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

{    
  "LTPAProfile": {
    "<NameOfLTPAProfile>": {
      "KeyFileName": "string",
      "Password": "string", 
      "Overwrite": true|false
     }
   }
}

NameOfLTPAProfile

这是必需属性。

指定 LTPA 概要文件的名称。

该名称最多可以包含 256 个字母数字字符。

名称不得包含开头空格或结尾空格，并不能包含控制字符、逗号、双引号、反斜杠或等号。第一个字符不能为数字。

创建概要文件之后，该名称将无法更改。

KeyFileName

在创建 LTPA 概要文件时为必需项。

指定与此 LTPA 概要文件一起使用的密钥文件的名称。 密钥文件必须存在于 IBM IoT MessageSight 上。

该名称最多可以包含 255 个字母数字字符。第一个字符不能为数字。

密码

在创建 LTPA 概要文件时为必需项。

指定与 LTPA 概要文件中使用的密钥文件相关联的 LTPA 密码。

REST API GET 方法将不会返回此参数的值。

Overwrite: true|false

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

缺省值为 false，即具有相同名称时，不会覆盖现有密钥。

用法说明

• 必须先将 LTPA 密钥文件复制到 IBM IoT MessageSight 中，然后才能将其用于 LTPA 概要文件。将本地计算机中的文件复制到 IBM IoT MessageSight 命令以复制 LTPA 密钥文件。
• 创建 LTPA 概要文件后，必须将其与安全概要文件相关联。
• 必须按照所示情况使用首字母大写和双引号。

相关的 REST 管理 API

• 将本地计算机中的文件复制到 IBM IoT MessageSight
• 创建或更新安全概要文件
• 显示可命名配置对象的配置详细信息
• 删除配置对象

示例

使用以下 cURL 复制名为 certificateKey.pem 的密钥：

curl -X PUT -T certificate.pem http://10.10.2.149:9089/ima/v1/file/ltpa.key

使用以下 cURL 来创建名为“MyLTPAProfile”的 LTPA 概要文件：

 
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
         "LTPAProfile": {   
           "MyLTPAProfile": {
             "KeyFileName": "ltpa.key",
             "Password": "ltpakeypassword"
          }
        }
    }
 '  \
http://127.0.0.1:9089/ima/v1/configuration/

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