Documentation
Table of Contents
> SLA-object
De volgende objecten hebben direct betrekking op de sla (Service Level Agreement) API.
SLA
Het SLA-object heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| slaid | string | ID van de SLA. Gedrag van de eigenschap: - alleen lezen - vereist voor update-operaties |
| name | string | Naam van de SLA. Gedrag van de eigenschap: - vereist voor maak-operaties |
| period | integer | Rapportageperiode van de SLA. Mogelijke waarden: 0 - dagelijks; 1 - wekelijks; 2 - maandelijks; 3 - driemaandelijks; 4 - jaarlijks. Gedrag van de eigenschap: - vereist voor maak-operaties |
| slo | float | Minimaal acceptabele Service Level Objective uitgedrukt als een percentage. Als de Service Level Indicator (SLI) lager wordt, wordt de SLA als problematisch/onvervuld beschouwd. Mogelijke waarden: 0-100 (tot 4 cijfers achter de komma). Gedrag van de eigenschap: - vereist voor maak-operaties |
| effective_date | integer | Effectieve datum van de SLA. Mogelijke waarden: datumtimestamp in UTC. |
| timezone | string | Rapportage tijdzone, bijvoorbeeld: Europe/Amsterdam, UTC.Voor de volledige lijst van ondersteunde tijdzones raadpleeg de PHP-documentatie. Gedrag van de eigenschap: - vereist voor maak-operaties |
| status | integer | Status van de SLA. Mogelijke waarden: 0 - (standaard) uitgeschakelde SLA; 1 - ingeschakelde SLA. |
| description | string | Omschrijving van de SLA. |
SLA Schema
Het SLA-schema-object definieert perioden waarin de verbonden service(s) gepland zijn om operationeel te zijn. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| period_from | integer | Starttijd van de terugkerende wekelijkse periode (inclusief). Mogelijke waarden: aantal seconden (geteld vanaf zondag). Gedrag van de eigenschap: - vereist |
| period_to | integer | Eindtijd van de terugkerende wekelijkse periode (exclusief). Mogelijke waarden: aantal seconden (geteld vanaf zondag). Gedrag van de eigenschap: - vereist |
Uitgesloten Downtime SLA
Het object voor uitgesloten downtimes definieert perioden waarin de verbonden service(s) gepland staan om buiten werking te zijn, zonder invloed op SLI, bijvoorbeeld tijdens gepland onderhoud. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| name | string | Naam van de uitgesloten downtime. Gedrag van de eigenschap: - vereist |
| period_from | integer | Starttijd van de uitgesloten downtime (inclusief). Mogelijke waarden: timestamp. Gedrag van de eigenschap: - vereist |
| period_to | integer | Eindtijd van de uitgesloten downtime (exclusief). Mogelijke waarden: timestamp. Gedrag van de eigenschap: - vereist |
SLA servicetag
Het object voor SLA-servicetag koppelt services om op te nemen in de berekeningen voor de SLA. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| tag | string | Naam van de SLA-servicetag. Gedrag van de eigenschap: - vereist |
| operator | integer | Operator van de SLA-servicetag. Mogelijke waarden: 0 - (standaard) is gelijk aan; 2 - komt overeen met |
| value | string | Waarde van de SLA-servicetag. |