Skip to end of metadata
Go to start of metadata

on this page...

Page purpose...

  • To list information about the Library's cluster-availability web-service.

Service information...

  • Programmatic access to library cluster-availability information is useful, for building user-services and custom-monitoring applications.
  • All data is returned in json format.
  • In general, a same-versioned-url indicates that no data will be removed, but data may be added.
  • Data for each url-variation is cached on the server for 30 seconds; multiple client requests will not require calculations more than once every 30 seconds. (Also, django's caching system automatically sets ETag and Last-Modified headers so requests to this api may not even require sending the cached file.)

Version 2...

  • (in production)
  • API that parses and returns json results.
  • 2010-09-26-Sun: added parameter 'all' (in addition to previous 'lib-all') to return not just library cluster info, but also info for 4 CIT clusters).
    • Note: cluster-availability info for the 4 CIT clusters is 'lightly-supported' – my priority-commitment is to library data, but this was incredibly easy to add, and likely any hacking solution to get our library data will be easily extendable to other clusters. This would be a great service for CIS to support in the future; I know there is receptivity to this.

Summary availability status

  • Example call:
  • Result:
  • Note: the 'calculated_available' value is the sum of the 'available' and 'offline' values, based on an August 2010 CIS change that Marc Doughty described to me. -bjd

Version 1...

  • (broken as of 2010-08, due to CIS map page not working) – may be resurrected due to the fact that it provides os-level info
  • was in use for approximately a year and a half

Summary availability status

  • Example call:
  • Result:
  • One would think that 'offline' would indicate either 'turned-off' or 'not-working', but it may mean something slightly different, since folk have reported seeing machines that work being reported as offline at the official CIS Cluster Availability page.
  • The 'sanity_check' value indicates whether the macosx and windows counts match up with the overall counts. The value should always be 'passed'.
  • The 'response' will be a 404 'not found' if the submitted place ('rock-level-1', in the above example) has no match.
  • As of this writing there are five API cluster-identifiers that return data: 'rock-level-1', 'rock-level-2-main', 'rock-level-2-grad', 'scili-friedman', and 'scili-mezzanine'. However, the 'lib-all' shortcut (see below) is the authoritative source of available cluster-identifiers.
  • For convenience, there are three 'shortcut' cluster-identifiers which show aggregated data: 'rock-all', 'scili-all', and 'lib-all'. The 'requested_cluster_identifier' will indicate the shortcut identifier entered, as well as the individual cluster-identifiers that comprise the shortcut.

Contact info...

  • Domain info:
  • Programming info:


Other links...

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.