Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


1.3.15 Members of a system profile threshold

This section explains the Members of a system profile threshold (SystemThresholdValue resource).

Member name Data type Description Whether to change Whether applicable to filter conditions ($query) Whether applicable to sort conditions ($order-by)
instanceID long ID for identifying instances N N N
monitoring boolean Whether the threshold is monitored.
  • true: Threshold is monitored
  • false: Threshold is not monitored
If this member is omitted, false is set.
Y N N
metricType string Identifier of the threshold. This member is not supported. N N N
displayName string Display name of the threshold. N N N
unit string String indicating the unit of the threshold. N N N
proportion boolean Direction of the threshold.
  • true: When the measured value falls below the threshold, an error or warning occurs.
  • false: When the measured value exceeds the threshold, an error or warning occurs.
N N N
thresholdValueOfWarning float Threshold for displaying warnings. You need to specify this threshold according to the following conditions:
  • Multiple of stepSize
  • Less than or equal to max
  • Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

Y N N
thresholdValueOfError float Threshold for displaying errors. You need to specify this threshold according to the following conditions:
  • Multiple of stepSize
  • Less than or equal to max
  • Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

Y N N
stepSize float Increment for the threshold N N N
max float Maximum value that can be specified for the threshold N N N
min float Minimum value that can be specified for the threshold N N N

(Legend) Y: Applicable, N: Not applicable