Runtime Diagnostics API call

Starting in z/OS® 3.1, Runtime Diagnostics incorporates support for a z/OSMF REST API. The REST API provides a standardized interface for interacting with Runtime Diagnostics. The returned data is in standardized JSON format. The Runtime Diagnostics return and reason codes are documented in this section. See IBM z/OS Management Facility Programming Guide for more information about using the z/OSMF REST API for Runtime Diagnostics.

The Runtime Diagnostics return and reason codes are listed in the following table.

Table 1. Runtime diagnostics return and reason codes
Hexadecimal return code and equate symbol	Decimal return code and equate symbol	Meaning and action
0 HzrRcOk	None. HzrRcOk	Successful completion. None.
4 HzrRcQualified	None. HzrRcQualified	Runtime Diagnostics encountered failures while processing the ANALYZE request. Refer to the action provided with the specific reason code.
8 HzrRcUserError	None. HzrRcUserError	Runtime Diagnostics detected one or more user errors. Refer to the action provided with the specific reason code.
C HzrRcEnvError	None. HzrRcEnvError	Runtime Diagnostics encountered one or more system failures while trying to detect system events. Refer to the action provided with the specific reason code.
E HZRRcParserError	None. HZRRcParserError	Unexpected failure occurred while trying to parse JSON text. Refer to the z/OS JSON parser documentation for the description of the reason codes.
10 HZRRcCompError	None. HZRRcCompError	Unexpected failure. Runtime Diagnostics processing ended abnormally. Contact IBM® Service.

All return and reason codes that are returned by Runtime Diagnostics are listed in the following table:

Table 2. Return and reason codes returned by Runtime Diagnostics
Hexadecimal reason code and Equate symbol	Decimal reason code and Equate symbol	Meaning and action
0 HzrRsnNoEvents	None. HzrRsnNoEvents	Runtime Diagnostics did not detect any system events. Examine the OUTAREA/JSON OUTPUT for detailed information about the request.
1 HzrRsnEvents	None. HzrRsnEvents	Runtime Diagnostics detected system events. Examine the OUTAREA/JSON OUTPUT for detailed information about the request.
0 HzrRsnQualNoEvents	None. HzrRsnQualNoEvents	Runtime Diagnostics did not detect any system events. Examine the OUTAREA/JSON OUTPUT for detailed information about the request.
1 HzrRsnQualEvents	None. HzrRsnQualEvents	Runtime Diagnostics detected system events. Examine the OUTAREA/JSON OUTPUT for detailed information about the request.
3 HzrRsnQualMaxEvents	None. HzrRsnQualMaxEvents	The maximum amount of storage that can be used by events found was reached. Some events are not included in the output. Analyze the events found and take action to reduce the number of events.
860 HzrRsnOutAreaLenTooSmall	None. HzrRsnOutAreaLenTooSmall	Caller invoked Runtime Diagnostics with an OUTAREALEN value that is too small. Invoke Runtime Diagnostics with less address space names in the list and take action to reduce the number of events.
871 HzrRsnBadAsNmCount	None. HzrRsnBadAsNmCount	Caller invoked Runtime Diagnostics with a bad number of address space names in the ASNMLIST. Correct the number of address space names in the list.
872 HzrRsnNoMatchingAsids	None. HzrRsnNoMatchingAsids	No address spaces were found that matched the input address space name. Ensure the input ASNAME or list of ASNAMES is correct.
874 HzrRsnBadAsName	None. HzrRsnBadAsName	An unsupported address space name was specified. When calling Runtime Diagnostics with the address space name option use supported address space names only.
1001 HzrRsnJSONParserError	None. HzrRsnJSONParserError	The JSON parser encountered an error. Contact IBM Support.

You can find additional reason codes at The z/OS JSON parser - IBM Documentation.