{"queryTime": 0,"objects": [{"messageBrokerName": "TEST","objectName": "QUEUE1","objectType": "STATISTICS","eventUid": "48c177ce-afe6-46db-b1fe-d93b80354b2c","entryTime": "May 2, 2016 11:18:19 PM","fields": {"getMsgsPersist": "0","reason": "MQRC_NONE","purgedMsgs": "0","endDate": "2016-05-02","type": "MQCFT_GROUP","getMsgsPerSec": "0","browseMsgsPersist": "1","maxQueueDepth": "1","avgQtimeNonPersist": "0","qmgrCommandLevel": "800","putDateTime": "Mon, 02 May 2016 23:18:18 +1000","getMsgsPerSecPersist": "0","getBytesPersist": "0","TYPE": "1","getFailed": "0","getBytesNonPersist": "0","put1Failed": "0","browseMsgsNonPersist": "0","putMsgsPerSecPersist": "0","strucLength": "16","version": "MQCFH_VERSION_3/MQCFH_CURRENT_VERSION","putMsgsNonPersist": "0","compCode": "MQCC_OK","expiredMsgs": "0","putBytesNonPersist": "0","browseBytesPersist": "3208","interval": "1800","QMNAME": "TEST","startDate": "2016-05-02","getMsgsNonPersist": "0","objectCount": "11","getMsgsPerSecNonPersist": "0","CRTIME": "13.02.46","string": "23.18.18","browsesFailed": "1","putBytesPersist": "0","putMsgsPerSec": "0","msgSeqNumber": "1","parameter": "Q_STATISTICS_DATA","startTime": "22.48.18","codedCharSetId": "0","stringLength": "8","value": "11","avgQtimePersist": "0","CRDATE": "2015-12-10","parameterCount": "22","putMsgsPerSecNonPersist": "0","control": "MQCFC_LAST","QUEUE": "QUEUE1","browseBytesNonPersist": "0","put1MsgsNonPersist": "0","msgsNotQueued": "0","Command": "165","DEFTYPE": "1","putsFailed": "0","put1MsgsPersist": "0","endTime": "23.18.18","putMsgsPersist": "0","minimumQueueDepth": "1"}}]}
| Table of Contents |
|---|
| Include Page | RESETQSTATS (Mainframe ZOS) | RESETQSTATS (Mainframe ZOS) |
| Include Page | STORAGE_CLASS | STORAGE_CLASS |
PAGESET_USAGE
ObjectType | Category | Log File | URL | Operating System |
|---|---|---|---|---|
PAGESET_USAGE | STATUS | statusData.log | ZOS Only |
{
"queryTime": 0,
"objects": [
{
"messageBrokerName": "MQD1",
"objectName": "1",
"objectType": "PAGESET_USAGE",
"className": "java.lang.Integer",
"entryTime": "14/12/2017 5:05:43 PM",
"fields": {
"USAGE_TYPE": "1168",
"UNUSED_PAGES": "556353",
"RESPONSE_ID": "c3e2d840d4d8c4f1404040d9d4d8c4f1d3956f5562c0bc1c",
"PAGESET_ID": "1",
"EXPAND_COUNT": "0",
"PERSIST_PAGES": "11329",
"BUFFER_POOL_ID": "1",
"COMMANDLEVEL": "800",
"PLATFORM": "ZOS",
"STATUS": "AVAILABLE",
"TOTAL_PAGES": "569483",
"EXPAND_TYPE": "1",
"QMNAME": "MQD1",
"NONPERSIST_PAGES": "1801"
}
}]}
SYSTEM
ObjectType | Category | Log File | URL | Operating System |
|---|---|---|---|---|
SYSTEM | OBJECT_CONFIG | objectData.log | ZOS Only |
{
"queryTime": 0,
"objects": [
{
"messageBrokerName": "MQD1",
"objectName": "MQD1",
"objectType": "SYSTEM",
"className": "java.lang.Integer",
"entryTime": "14/12/2017 4:48:52 PM",
"fields": {
"OPERATION_MODE": "0 701",
"CCSID": "0",
"DB2_BLOB_TASKS": "4",
"SMF_ACCOUNTING": "YES",
"RESLEVEL_AUDI": "YES",
"ROUTING_CODE": "1",
"TRACE_SIZE": "99",
"QSG_NAME": "",
"PLATFORM": "ZOS",
"WLM_INT_UNITS": "0",
"OTMA_MEMBER": "",
"OTMA_DRU_EXIT": "DFSYDRU0",
"MULC_CAPTURE": "STANDARD",
"CMD_USER_ID": "MXMQSER1",
"SMF_STATS": "YES",
"OTMA_GROUP": "",
"OTMA_TPIPE_PREFIX": "CSQ",
"EXIT_TASKS": "8",
"Q_INDEX_DEFER": "NO",
"TRACE_CLASS": "",
"MAX_ACE_POOL": "0",
"RESPONSE_ID": "c3e2d840d4d8c4f1404040d9d4d8c4f1d3956b911c31ff24",
"WLM_INTERVAL": "30",
"DB2_NAME": "",
"CLUSTER_CACHE": "DYNAMIC",
"CONNECTION_SWAP": "YES",
"DSG_NAME": "",
"DB2_TASKS": "4",
"EXCL_OPERATOR_MESSAGES": "",
"SPLCAP": "NOT_SUPPORTED",
"COMMANDLEVEL": "800",
"SYSP_TYPE": "10",
"CHKPOINT_COUNT": "500000",
"OTMA_INTERVAL": "2147483647",
"SMF_INTERVAL": "30",
"EXIT_INTERVAL": "30",
"QMNAME": "MQD1"
}
}
]
}
...
ObjectType | Category | Log File | URL | Operating System |
|---|---|---|---|---|
LOG | OBJECT_CONFIG | objectData.log | ZOS Only |
{"queryTime": 0,"objects": [{"messageBrokerName": "MQZOS","objectName": "MQZOS","objectType": "LOG","className": "java.lang.Integer","entryTime": "02/05/2016 4:11:56 PM","fields": {"MQIACF_SYSP_ARCHIVE": "1","MQIACF_SYSP_OUT_BUFFER_COUNT": "20","MQIACF_SYSP_MAX_ARCHIVE": "500","MQIACF_LOG_COMPRESSION": "0","MQIACF_SYSP_OUT_BUFFER_SIZE": "4000","MQIACF_SYSP_TYPE": "10","MQBACF_RESPONSE_ID": "c3e2d840d4d8c4f1404040d9d4d8c4f1d0ae62760f5bacd6","MQIACF_SYSP_DUAL_ACTIVE": "0","MQIACF_SYSP_DUAL_ARCHIVE": "0","MQIACF_SYSP_IN_BUFFER_SIZE": "60","MQIACF_SYSP_MAX_READ_TAPES": "3","MQIACF_SYSP_DEALLOC_INTERVAL": "0","MQIACF_SYSP_DUAL_BSDS": "1","MQCACF_RESPONSE_Q_MGR_NAME": "MQZOS"}}]}
STATISTICS
ObjectType | Category | Log File | URL | Operating System |
|---|---|---|---|---|
STATISTICS | STATS_MESSAGE | statsData.log | All NON-ZOS |
|
The HTTP Gateway can be accessed using your favourite http client. Some recommendations are:
- curl
- wget
- Postman (Google Chrome Extension)
For the request URL format, the use of headers, response codes, etc. follow the conventions recommended for a RESTful API. This is described in detail below:
Required Header:
| Tip |
|---|
Accept application/json (Return requested data in JSON format) or Accept application/xml (Return requested data in XML format) |
| Info |
|---|
| Please note, a .* wildcard value can only be used as part of the objectName and fieldValue segments. A message "Warning": "Search returned no results." will be returned if used elsewhere. |
Table of Web Service REST URIs
| Include Page | ||||
|---|---|---|---|---|
|
Structuring a Request
| Include Page | ||||
|---|---|---|---|---|
|
Mainframe ZOS (Only)
RESETQSTATS
| Include Page | ||||
|---|---|---|---|---|
|
STORAGE_CLASS
| Include Page | ||||
|---|---|---|---|---|
|
PAGESET_USAGE
| Include Page | ||||
|---|---|---|---|---|
|
SYSTEM
| Include Page | ||||
|---|---|---|---|---|
|
LOG
| Include Page | ||||
|---|---|---|---|---|
|
Q_STATISTICS
| Include Page | ||||
|---|---|---|---|---|
|
QUEUE_STATUS
| Include Page | ||||
|---|---|---|---|---|
|
SUBSCRIPTION_STATUS
| Include Page | ||||
|---|---|---|---|---|
|
Using CURL
| Include Page | ||||
|---|---|---|---|---|
|
Displaying Message Payloads
| Include Page | ||||
|---|---|---|---|---|
|