Status Page¶
This is a standalone module containing all StatusPage related return classes, responsible for fetching the current server status from the status page.
-
class
arez.
StatusPage
(url, *, loop=None)[source]¶ An object representing StatusPage access.
- Parameters
url (str) – The URL of the StatusPage you want to get this object for.
-
await
get_status
()[source]¶ Fetches the current statuspage’s status.
- Returns
The current status requested.
- Return type
- Raises
aiohttp.ClientError – When there was an error while fetching the current status.
-
class
arez.statuspage.
CurrentStatus
[source]¶ Represents the current server’s status.
-
updated_at
¶ The timestamp of when the current status was last updated.
- Type
-
status
¶ The current overall page’s status.
- Type
Literal[“All Systems Operational”, “Major System Outage”, “Partial System Outage”, “Minor Service Outage”, “Degraded System Service”, “Partially Degraded Service”, “Service Under Maintenance”]
-
impact
¶ The current overall page’s impact.
- Type
Literal[“None”, “Minor”, “Major”, “Critical”]
-
color
¶ The color associated with this status (based on impact).
There is an alias for this under
colour
.- Type
-
components
¶ A list of components this status page contains. This doesn’t include groups.
-
groups
¶ A list of component groups this status page contains. This includes groups only.
- Type
-
maintenances
¶ A list of scheduled maintenances.
- Type
-
-
class
arez.statuspage.
ComponentGroup
[source]¶ Represents a component’s group.
-
created_at
¶ The time when this component group was created.
- Type
-
updated_at
¶ The last time this component group was updated.
- Type
-
status
¶ The current component group’s status.
This represents the worst status of all of the components in a group.
Under Maintenance
is considered second worst.- Type
Literal[“Operational”, “Under Maintenance”, “Degraded Performance”, “Partial Outage”, “Major Outage”]
-
color
¶ The color associated with this component (based on status).
There is an alias for this under
colour
.- Type
-
maintenances
¶ A list of scheduled maintenances referring to components of this group.
- Type
-
-
class
arez.statuspage.
Component
[source]¶ Represents a status component.
-
created_at
¶ The time when this component was created.
- Type
-
updated_at
¶ The last time this component was updated.
- Type
-
status
¶ The current component’s status.
- Type
Literal[“Operational”, “Under Maintenance”, “Degraded Performance”, “Partial Outage”, “Major Outage”]
-
color
¶ The color associated with this component (based on status).
There is an alias for this under
colour
.- Type
-
group
¶ The component group this component belongs to.
Can be
None
if it belongs to no group.- Type
ComponentGroup | None
-
maintenances
¶ A list of maintenances referring to this component.
- Type
-
-
class
arez.statuspage.
Incident
[source]¶ Represents an incident.
-
created_at
¶ The time when this incident was created.
- Type
-
updated_at
¶ The last time this incident was updated.
- Type
-
status
¶ The current incident’s status.
- Type
Literal[“Investigating”, “Identified”, “Monitoring”, “Resolved”, “Postmortem”]
-
impact
¶ The impact of this incident.
- Type
Literal[“None”, “Minor”, “Major”, “Critical”]
-
color
¶ The color associated with this incident (based on impact).
There is an alias for this under
colour
.- Type
-
-
class
arez.statuspage.
Maintenance
[source]¶ Represents a (scheduled) maintenance.
-
created_at
¶ The time when this maintenance was created.
- Type
-
updated_at
¶ The last time this maintenance was updated.
- Type
-
status
¶ The current maintenance’s status.
- Type
Literal[“Scheduled”, “In Progress”, “Verifying”, “Completed”]
-
impact
¶ The impact of this maintenance.
- Type
Literal[“Maintenance”]
-
color
¶ The color associated with this maintenance (based on impact).
There is an alias for this under
colour
.- Type
-
scheduled_for
¶ The planned time this maintenance is to start.
- Type
-
scheduled_until
¶ The planned time this maintenance is to end.
- Type
-