Cas

List of CAS nodes with CPU load

List of nodes running CAS servers, including cpuLoad of the system running the CAS server. Retrieving the load information requires extra communication with the grid nodes. /cas/nodes is provided for cases where performance is of the essence and CPU load information is not needed.

get/cas/nodes/metrics

Request

  • Base URL: http://mock-cas.apifirst.unx.sas.com/cas
  • URL: http://mock-cas.apifirst.unx.sas.com/cas/cas/nodes/metrics
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (implicit, authorization URL https://site-specific-url)

Response

OK

namestring

The name of the node. May or may not match the actual hostname of the node depending on the name used in the grid hosts file.

portinteger

The port number being used by the CAS protocol listener.

type'Controller' | 'Worker' | 'BackupController' | 'Backup'

CAS Server type. 'BackupController' and 'Backup' are synonyms. Compare for both values to determine if server is a backup controller.

connectedboolean

Indicates if the server is running and connected to the grid.

pidinteger

The process ID of the CAS server process.

httpPortinteger

Port being used by HTTP listener.

httpProtocol'http' | 'https'

Protocol being used by HTTP listener.

uuidstring

Unique identifier for the node.

cpuLoadnumber double

CPU load on the system. CAS servers running on Windows return 0.

Changes

No recorded changes to this operation across all 1 revision of this API.