Alerts API - GET dimensions for alert type

Applies to NAM 2019

This documentation is a work in progress. Please see the NAM REST API Explorer in your NAM Console for a 'Swaggerized' exploration of the NAM Console Public REST API.

Returns dimensions available for specified alert type.

GET
  • url https://{console-host}:{console-port}/cxf/api/v1/config/alerts/dimensions/{alertType}

Parameters

Parameter Type Description In Required
alertType

Alert type.

path required
namServer

Include only dimensions available on the specified NAM servers.

query optional
filter

Include only dimensions containing the specified text.

query optional

Possible values

Possible values for the schema element:

  • METRIC_ALM
  • TRANSMETRIC_ALM
  • TRANSACTIVE_METRIC_ALM
  • GOMEZSTEP_METRIC_ALM
  • GOMEZTEST_METRIC_ALM
  • CITRIXMETRIC_ALM
  • LINK_ALM
  • METRIC_ALM_P2P
  • TIERMETRIC_ALM
  • AMD_DRIVER_ALM
  • AMD_INTERFACE_ALM
  • AMD_SERVER_ALM
  • ESM_METRIC_ALM
  • SYSTEM

Response format

The DmiEntity object

Element Type Description
id string
name string
unit string
dmiType string
alertDataType string
baselineAvailable boolean
alertType string

Response codes

Code Description
default

Dimensions available for a given alert type. If no NAM Server is specified, this is the common set of dimensions for all available NAM Servers. If one or more NAM Servers are specified as parameters, it is the common set for the specified NAM Servers.