This article contains a list of REST API commands that pertain to IBM MQ clusters.
For a walk-through of the Navigator REST API using the demo site, see Using the REST API using the Navigator demo system. No installation is required. The article Performing REST API operations using the Swagger UI includes three detailed examples, as well as instructions for issuing plain text or JSON-formatted MQSC Commands through the REST API.
Search Cluster Queue Managers
GET /ibmmq/clusters
Purpose: Finds the clusters on the node and its queue managers.
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/clusters?nodeName=LEUNAME" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
[
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "LEUNAME",
"clusterQMgrName": "LEUNAME",
"clusterName": "Cluster",
"channelName": "TO.LEUNAME"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "QA",
"clusterQMgrName": "LEUNAME",
"clusterName": "Cluster",
"channelName": "TO.LEUNAME"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "QA",
"clusterQMgrName": "QA",
"clusterName": "Cluster",
"channelName": "TO.QA"
},
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "LEUNAME",
"clusterQMgrName": "SYSTEM.TEMPQMGR.LEUNAME(1414)",
"clusterName": "Cluster",
"channelName": "TO.QA"
}
]
Read Cluster Queue Manager Data
GET /ibmmq/clusters/{nodeName}/{qmgrName}/{clusterQMgrName}/{clusterName}/{channelName}
Purpose: Finds the schedule job and returns its attributes. You must either enter attributes or an asterisk in the attributes parameter to retrieve details about the job.
Curl example
curl -X GET "http://jenkins.nastel.com:8019/rest/v1/ibmmq/clusters/LEUNAME/QA/QA/Cluster/TO.QA?attributes=%2A" -H "accept: application/json" -H "Authorization: Basic QWRtaW46YWRtaW4="
Example Response
{
"wgsName": "MQM",
"nodeName": "LEUNAME",
"qmgrName": "QA",
"clusterQMgrName": "QA",
"clusterName": "Cluster",
"channelName": "TO.QA",
"uri": "/rest/v1/ibmmq/clusters/LEUNAME/QA/QA/Cluster/TO.QA",
"general": {
"qmgrType": "Repository",
"qmgrId": "QA_2014-08-29_15.14.41",
"description": "",
"qmgrDefType": "Cluster Receiver",
"xmitProtocolType": "TCP",
"connectionName": "LEUNAME(1414)",
"localAddress": "",
"xmitQName75": "",
"xmitQName": ""
},
"extended": {
"maxMsgLength": 4194304,
"seqNumberWrap": 999999999,
"discInterval": 6000,
"heartbeatInterval": 300,
"batchHeartbeat": 0,
"batchSize": 50,
"batchInterval": 0,
"batchDataLimit": 5000,
"keepAliveInterval": -1,
"npmSpeed": "Fast",
"putAuthority": "Default",
"dataConversion": "Disabled"
},
"mca": {
"mcaName": "",
"mcaType": "Thread",
"mcaUserId": ""
},
"exit": {
"sendExitName": "",
"sendExitUserData": "",
"recvExitName": "",
"recvExitUserData": "",
"secExitName": "",
"secExitUserData": "",
"msgExitName": "",
"msgExitUserData": "",
"mrExitName": "",
"mrExitUserData": ""
},
"lu62": {
"modeName": "",
"tpName": "",
"userId": "",
"password": ""
},
"retry": {
"shortRetry": 10,
"shortRetryTimer": 60,
"longRetry": 999999999,
"longRetryTimer": 1200,
"msgRetryCount": 10,
"msgRetryInterval": 1000
},
"cluster": {
"clwlPriority": 0,
"clwlRank": 0,
"clwlWeight": 50,
"networkPriority": 0
},
"ssl": {
"sslCipherSpec": "",
"sslPeerName": "",
"sslClientAuth": "Required"
},
"compression": {
"hdrCompression": [
0,
-1
],
"msgCompression": [
0,
-1
]
},
"monitoring": {
"monitoring": "Off",
"statistics": "Off"
},
"state": {
"lastUpdated": 1643912163000,
"status": "Inactive",
"altDate": "2021-08-11",
"altTime": "10.56.35",
"clusDate": "2021-03-25",
"clusTime": "06.04.41",
"suspend": "No"
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": []
},
"customProperties": {}
}