sfapi-ts

Home > @cjh1/sfapi > StatusService

StatusService class

Signature:

export declare class StatusService 

Constructors

Constructor	Modifiers	Description
(constructor)(httpRequest)		Constructs a new instance of the StatusService class

Properties

Property	Modifiers	Type	Description
httpRequest	readonly	BaseHttpRequest

Methods

Method	Modifiers	Description
getNotes()		Read Notes Get NERSC system status notes.
getNotesBySystem(name)		<p>Read Note Get information about NERSC system status notes for a specific system.</p><p>- **name**: the name of the NERSC resource to query</p>
getOutages()		Read Outages Get information about NERSC system outages.
getOutagesBySystem(name)		<p>Read Outage Get information about NERSC outages for a specific system.</p><p>- **name**: the name of the NERSC resource to query</p>
getPlannedOutages()		Read Planned Outages Get information about NERSC planned system outages.
getPlannedOutagesBySystem(name)		<p>Read Planned Outages Get information about NERSC planned outages for a specific system.</p><p>- **name**: the name of the NERSC resource to query</p>
getStatus()		Read Statuses Get the NERSC system statuses.
getStatusBySystem(name)		<p>Read Status Get the status of a specific NERSC system.</p><p>- **name**: the name of the NERSC resource to query</p><p>Return values for **status** are:</p><p>- **“active”**: system is fully functional - **“degraded”**: system functional but possibly with degraded performance - **“unavailable”**: system is down, e.g. during a maintenance - **“other”**: status undefined (rare)</p>