Status

Get

get

Retrieve the runtime state of the HALB Virtual Server (amalgamation of all HALB Device states).

Path parameters
idinteger · int32Required

The ID of the HALB Virtual Server

Responses
chevron-right
200

Success

application/json; api-version=1.0

HALB Virtual Server Status

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:
serverTypestring · enumOptional

RAS Status Type

Possible values:
agentVerstring · nullableOptional

Agent Version.

serverstring · nullableOptional

Server name.

serverOSstring · nullableOptional

Server Operating System.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

machineIdstring · nullableOptional

Id of the machine

logLevelstring · enumOptional

RAS Log Level

Possible values:
cpuLoadinteger · int32Optional

CPU load percentage.

memLoadinteger · int32Optional

Memory load percentage.

diskReadinteger · int32Optional

Disk Read.

diskWriteinteger · int32Optional

Disk Write.

enabledbooleanOptional

Whether the object is enabled or not.

deviceIDinteger · int32Optional
deviceIPstring · nullableOptional
get
/api/HALB/{id}/status

List

get

Retrieve the runtime state of the HALB Virtual Server (amalgamation of all HALB Device states).

Query parameters
NamestringOptional

The name of the HALB Virtual Server

SiteIdinteger · int32Optional

The site ID where the HALB Virtual Server resides

Responses
chevron-right
200

Success

application/json; api-version=1.0

HALB Virtual Server Status

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:
serverTypestring · enumOptional

RAS Status Type

Possible values:
agentVerstring · nullableOptional

Agent Version.

serverstring · nullableOptional

Server name.

serverOSstring · nullableOptional

Server Operating System.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

machineIdstring · nullableOptional

Id of the machine

logLevelstring · enumOptional

RAS Log Level

Possible values:
cpuLoadinteger · int32Optional

CPU load percentage.

memLoadinteger · int32Optional

Memory load percentage.

diskReadinteger · int32Optional

Disk Read.

diskWriteinteger · int32Optional

Disk Write.

enabledbooleanOptional

Whether the object is enabled or not.

deviceIDinteger · int32Optional
deviceIPstring · nullableOptional
get
/api/HALB/status