Skip to main content
REST API reference

Retrieve the environment sensors for a node

PDFs

GET /cluster/sensors/{node.uuid}/{index}

Introduced In: 9.11

Retrieve Environment Sensors

Parameters

Name Type In Required Description

index

string

path

True

Filter by index

node.uuid

string

path

True

Filter by node.uuid

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

critical_high_threshold

integer

Value above which the sensor goes into a critically high state.

critical_low_threshold

integer

Value below which the sensor goes into a critically low state.

discrete_state

string

Used to determine whether the sensor is in a normal state or any other failed state based on the value of "discrete_value" field. This field is only applicable for discrete sensors.

discrete_value

string

Applies to discrete sensors which do not have an integer value. It can have values like on, off, good, bad, ok.

index

integer

Provides the sensor ID.

name

string

Name of the sensor.

node

node

threshold_state

string

Used to determine whether the sensor is in a normal state or any other failed state.

type

string

Used to determine the type of the sensor.

value

integer

Provides the sensor reading.

value_units

string

Units in which the "value" is measured. Some examples of units are mV, mW*hr, C, RPM.

warning_high_threshold

integer

Value above which the sensor goes into a warning high state.

warning_low_threshold

integer

Value below which the sensor goes into a warning low state.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "critical_high_threshold": 0,
  "critical_low_threshold": 0,
  "discrete_state": "normal",
  "discrete_value": "ok",
  "index": 0,
  "name": "PVCCSA CPU FD",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "threshold_state": "normal",
  "type": "string",
  "value": 831,
  "value_units": "mV",
  "warning_high_threshold": 0,
  "warning_low_threshold": 0
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string
Name Type Description

self

href

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.