创建或更新队列管理器连接
作用
创建或更新队列管理器连接。队列管理器连接可指定一个队列管理器的连接详细信息。URI
使用具有以下 IBM® IoT MessageSight 配置 URI 的 IBM IoT MessageSight REST API POST 方法:
http://<admin-endpoint-IP:Port>/ima/v1/configuration/
对象配置数据
使用以下模式在 POST 方法的有效内容中提供 QueueManagerConnection 对象配置数据。Content-type 设置为 application/json:
{
"QueueManagerConnection": {
"<NameOfQueueManagerConnection>": {
"QueueManagerName": "string",
"ConnectionName": "string",
"ChannelName": "string",
"SSLCipherSpec": "string",
"ChannelUserName": "string",
"ChannelUserPassword": "string",
"MQSSLKey": "string",
"MQStashPassword": "string",
"Verify": true|false,
"Force": true|false,
"Overwrite": true|false
}
}
}
其中:- NameOfQueueManagerConnection
- 这是必需属性。
- 指定队列管理器连接的名称。创建队列管理器连接后,无法更改此名称。
- 名称不得包含开头空格或结尾空格,并不能包含控制字符、逗号、双引号、反斜杠或等号。第一个字符不得是数字或以下任意特殊字符:
- ! # $ % & ' ( ) * + - . / : ; < > ? @
- 名称的最大长度为 256 个字符。
- QueueManagerName
- 在创建队列管理器连接时为必需项。
- 指定要连接到的队列管理器的名称。
- ConnectionName
- 在创建队列管理器连接时为必需项。
- 指定要连接到的队列管理器的连接名称。
- 连接名称由队列管理器的 IP 地址或主机名以及端口号(可选)组成。如果未指定端口号,将使用缺省值 144。对于多实例队列管理器,您可以通过输入以逗号分隔列表形式显示的连接名称来指定多个连接。
- 对于有端口号的连接名称,您必须在括号中指定端口号。例如:192.0.2.0(1414) 对于无端口号的连接名称,请勿使用小括号。例如:192.0.2.0
- ChannelName
- 在创建队列管理器连接时为必需项。
- 指定队列管理器的通道名称。
- 指定的名称必须匹配在 IBM MQ 中定义的服务器连接通道的名称。
- SSLCipherSpec
- 可选。
- 指定在 IBM IoT MessageSight 与 IBM MQ 间的连接中使用的 SSL 密码规范。
- 指定的密码必须匹配在 IBM MQ 中针对队列管理器连接中使用的队列管理器定义的密码。
- ChannelUserName
- 可选。
- 指定要提供给 IBM MQ 连接通道认证的用户名。
- 名称的最大长度为 1024 个字符。
- 如果指定了通道用户名,那么还必须指定通道用户密码。
- ChannelUserPassword
- 可选。
- 指定要提供给 IBM MQ 连接通道认证的密码
- 密码的最大长度为 256 个字符。
- 如果指定了通道用户名,那么必须指定通道用户密码。
- MQSSLKey
- 指定密钥数据库文件的名称。
- MQStashPassword
- 指定密码隐藏文件的名称。
- Verify: true|false
- 指定是否在不落实配置更改的情况下使用配置更改来测试队列管理器连接。
- 将此值设置为 true 可验证您输入的配置是否有效。
- 缺省值为 false,表示将直接落实配置更改,而不会先测试队列管理器连接。
- Force: true|false
- 指定强制删除或更新队列管理器连接。此操作可能导致 XA 事务标识成为孤立项。
- Overwrite: true|false
- 指定在证书和密钥具有相同名称时,是否覆盖现有证书和密钥。
- 缺省值为 false,表示在同名的情况下不覆盖现有的证书和密钥。
用法说明
- 必须先将密钥数据库文件和隐藏密码文件复制到服务器,然后才能将其应用于 IBM IoT MessageSight。将本地计算机中的文件复制到 IBM IoT MessageSight 以复制密钥数据库文件和隐藏密码文件。
- 只能复制一个密钥数据库文件和一个隐藏密码文件。如果要使用其他文件,必须覆盖现有文件。
- 只有在禁用使用队列管理器连接的所有目标映射规则后,才能编辑队列管理器连接。可以使用创建或更新目标映射规则 中所述的 REST API POST 方法禁用目标映射规则。
- 确保按示例所示使用大写形式和双引号。
相关的 REST 管理 API
示例
使用以下 cURL 来创建名为“MyQMC”的队列管理器连接:curl -X POST \
-H 'Content-Type: application/json' \
-d '{
"QueueManagerConnection": {
"MyQMC": {
"QueueManagerName": "QM1",
"ConnectionName": "192.0.2.0(1415)",
"ChannelName": "SYSTEM.IMA.SVRCONN",
"MQSSLKey": "my.kdb",
"MQStashPassword": "mq.sth"
}
}
}
' \
http://127.0.0.1:9089/ima/v1/configuration/
POST 方法的响应示例:
{
"Version": "v1",
"Code": "CWLNA6011",
"Message": "The requested configuration change has completed successfully."
}