Skip to main content
A newer release of this product is available.

Retrieve environment sensors

Contributors
PDFs

GET /cluster/sensors

Introduced In: 9.11

Retrieve Environment Sensors

Parameters

Name Type In Required Description

critical_low_threshold

integer

query

False

Filter by critical_low_threshold

warning_high_threshold

integer

query

False

Filter by warning_high_threshold

type

string

query

False

Filter by type

threshold_state

string

query

False

Filter by threshold_state

index

integer

query

False

Filter by index

value

integer

query

False

Filter by value

discrete_value

string

query

False

Filter by discrete_value

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

value_units

string

query

False

Filter by value_units

critical_high_threshold

integer

query

False

Filter by critical_high_threshold

name

string

query

False

Filter by name

warning_low_threshold

integer

query

False

Filter by warning_low_threshold

discrete_state

string

query

False

Filter by discrete_state

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of Records

records

array[sensors]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": {
    "_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": "agent",
    "value": 831,
    "value_units": "mV",
    "warning_high_threshold": 0,
    "warning_low_threshold": 0
  }
}

Error

Status: Default, Error
Name Type Description

error

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

next

href

self

href
Name Type Description

self

href

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

sensors

Environment Sensors

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 detrmine 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.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.