Get system status information
get
https://{managementIp}/rest/{version}/system/status
Retrieves the system uptime, system health, and HA/redundancy information (if configured as an HA system).
Request
Path Parameters
-
version: string
REST API version string.
Available values: v1.1
Header Parameters
-
Authorization:
The value in the Authorization header must be the string "
Bearer {access token}", where{access token}is a valid, unexpired token received in response to a prior/rest/{version}/auth/tokenrequest.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
200 Response
OK - Requested data is returned in response body
Nested Schema : data
Type:
Show Source
object-
haHealthScorePercent(optional):
integer
Minimum Value:
0Maximum Value:100Example:100 -
haPeerName(optional):
string
Example:
thewater-ed -
haPeerRole(optional):
string
Allowed Values:
[ "active", "standby", "out of service" ]Example:standby -
haSockets(optional):
integer
Example:
2 -
haSwitchOvers(optional):
integer
Example:
2 -
haSyncState(optional):
array haSyncState
-
healthScorePercent(optional):
integer
Minimum Value:
0Maximum Value:100Example:100 -
hostName(optional):
string
Example:
thewater-sd -
role(optional):
string
Allowed Values:
[ "active", "standby", "out of service" ]Example:active -
switchOverLogs(optional):
array switchOverLogs
-
systemState(optional):
string
Allowed Values:
[ "online", "offline" ]Example:online -
upTime(optional):
integer
Example:
861830
Nested Schema : links
Type:
objectNested Schema : messages
Type:
objectNested Schema : component
Type:
Show Source
object-
name(optional):
string
Example:
tCCD -
state(optional):
string
Allowed Values:
[ "disabled", "enabled", true, false ]Example:disabled
Nested Schema : switchOver
Type:
Show Source
object-
info(optional):
string
Example:
Active to RelinquishingActive, forced by command -
newState(optional):
string
Allowed Values:
[ "Active", "RelinquishingActive" ]Example:RelinquishingActive -
oldState(optional):
string
Allowed Values:
[ "Active", "RelinquishingActive" ]Example:Active -
time(optional):
string
Example:
2018-09-05T08:41:55.0-0400
400 Response
The request is malformed in some way or is missing required information and therefore cannot be processed.
Nested Schema : data
Type:
objectNested Schema : items
Type:
Show Source
object-
link(optional):
string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
Nested Schema : items
Type:
Show Source
object-
errorMessage(optional):
string
Example:
Error message string
401 Response
Unauthorized - Request lacks valid authentication credentials.
Nested Schema : data
Type:
objectNested Schema : items
Type:
Show Source
object-
link(optional):
string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
Nested Schema : items
Type:
Show Source
object-
errorMessage(optional):
string
Example:
Error message string
404 Response
Resource not found
Nested Schema : data
Type:
objectNested Schema : items
Type:
Show Source
object-
link(optional):
string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
Nested Schema : items
Type:
Show Source
object-
errorMessage(optional):
string
Example:
Error message string
Examples
Example of Accessing the API with cURL
The following example shows how to get system status information by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET \
--header "Accept: application/xml" \
--header "Authorization: Bearer $TOKEN" \
"https://10.0.0.2/rest/v1.1/system/status"Example of Accessing the API with Python
The following example shows how to get system status information by submitting a GET request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate.
import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url = "https://10.0.0.2/rest/v1.1/system/status"
resp = requests.get(url, headers=headers)Example of the Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK
Date: Thu, 17 Jan 2019 13:06:34 GMT
Cache-Control: no-cache
Content-Length: 299
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Thu, 17 Jan 2019 13:06:34 GMT
X-Appweb-Seq: 36Example of the Response Body
The following example shows the contents of the response body in XML format.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<data>
<uptimeSeconds>146091</uptimeSeconds>
<hostName>PRIMARY</hostName>
<systemState>online</systemState>
<role>standalone</role>
<healthScorePercent>100</healthScorePercent>
</data>
<messages/>
<links/>
</response>