Google Search Appliance Administrative API Developers Guide: Protocol - Manual (Page 73)

Google Search Appliance: Administrative API Developer’s Guide: Protocol 73
System Status
Retrieve the system status for a search appliance using the systemStatus entry of the status feed.
Note: Health properties differ by versions of the search appliance.
Retrieving a System Status Entry
To get the current search appliance system status, send an authenticated GET request to the status
feed URL:
http://Search_Appliance:8000/feeds/status/systemStatus
The following result is an entry that includes current system status values for the search appliance:
<?xml version=’1.0’ encoding=’UTF-8’?>
<entry xmlns=’http://www.w3.org/2005/Atom’
xmlns:gsa=’http://schemas.google.com/gsa/2007’>
<id>http://gsa:8000/feeds/status/systemStatus</id>
<updated>2008-12-09T23:53:14.288Z</updated>
<link rel=’self’ type=’application/atom+xml’
href=’http://gsa:8000/feeds/status/systemStatus’/>
<link rel=’edit’ type=’application/atom+xml’
href=’http://gsa:8000/feeds/status/systemStatus’/>
<gsa:content name=’entryID’>systemStatus</gsa:content>
<gsa:content name=’overallHealth’>0</gsa:content>
<gsa:content name=’diskCapacity’>0</gsa:content>
<gsa:content name=’raidHealth’>0</gsa:content>
<gsa:content name=’cpuTemperature’>0</gsa:content>
<gsa:content name=’machineHealth’>0</gsa:content>
</entry>
Property Description
cpuTemperature Temperature of the CPU: 0 if okay, 1 if caution, 2 if critical.
diskCapacity Remaining disk capacity of the search appliance: 0 if okay, 1 if caution, 2 if
critical.
machineHealth Health of the internal system components: 0 if okay, 1 if caution, 2 if critical.
overallHealth Overall health of the entire search appliance: 0 if okay, 1 if caution, 2 if
critical.
raidHealth Health of the raid array: 0 if okay, 1 if caution, 2 if critical.