Documentation
Table of Contents
> Maintenance object
Poniższe obiekty są bezpośrednio powiązane z interfejsem API maintenance.
Maintenance
Obiekt maintenance ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| maintenanceid | string | (tylko do odczytu) ID okresu utrzymania. |
| name (wymagane) |
string | Nazwa okresu utrzymania. |
| active_since (wymagane) |
timestamp | Czas rozpoczęcia okresu utrzymania. Podana wartość będzie zaokrąglona w dół do minut. |
| active_till (wymagane) |
timestamp | Czas zakończenia okresu utrzymania. Podana wartość będzie zaokrąglona w dół do minut. |
| description | string | Opis okresu utrzymania. |
| maintenance_type | integer | Typ utrzymania. Możliwe wartości: 0 - (domyślne) ze zbieraniem danych; 1 - bez zbierania danych. |
| tags_evaltype | integer | Metoda oceny znaczników problemów. Możliwe wartości: 0 - (domyślne) I/Lub; 2 - Lub. |
Należy zauważyć, że dla niektórych metod (aktualizacja, usuwanie) kombinacja parametrów wymaganych i opcjonalnych jest różna.
Time period
Obiekt time period służy do określenia momentów, kiedy okres utrzymania ma wejść w życie. Posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| period | integer | Czas trwania okresu utrzymania w sekundach. Podana wartość zostanie zaokrąglona w dół do minut. Domyślnie: 3600. |
| timeperiod_type | integer | Typ okresu czasu. Możliwe wartości: 0 - (domyślne) jednorazowo; 2 - dziennie; 3 - tygodniowo; 4 - miesięcznie. |
| start_date | timestamp | Data, kiedy okres utrzymania ma wejść w życie. Używane tylko dla jednorazowych okresów. Podana wartość zostanie zaokrąglona w dół do minut. Domyślnie: aktualna data. |
| start_time | integer | Czas, kiedy okres utrzymania się zaczyna, w sekundach. Używane dla okresów codziennych, tygodniowych i miesięcznych. Podana wartość zostanie zaokrąglona w dół do minut. Domyślnie: 0. |
| every | integer | Używane dla okresów codziennych, tygodniowych i miesięcznych. Dla okresów codziennych i tygodniowych, every określa interwały dni lub tygodni, w których okres utrzymania ma wejść w życie.Domyślnie: 1. Dla okresów miesięcznych, jeśli właściwość dayofweek zawiera przynajmniej jeden wybrany dzień tygodnia, właściwość every określa tydzień miesiąca, w którym okres utrzymania ma wejść w życie.Możliwe wartości: 1 - (domyślne) pierwszy tydzień; 2 - drugi tydzień; 3 - trzeci tydzień; 4 - czwarty tydzień; 5 - ostatni tydzień. |
| dayofweek | integer | Dni tygodnia, w których okres utrzymania ma wejść w życie. Dni są przechowywane w formie binarnej, gdzie każdy bit reprezentuje odpowiedni dzień. Na przykład, 4 równa się 100 w systemie binarnym i oznacza, że utrzymanie będzie aktywowane w środę. Używane dla okresów tygodniowych i miesięcznych. Wymagane tylko dla okresów tygodniowych. Przynajmniej jedna właściwość dayofweek lub day musi być określona dla okresów miesięcznych. |
| day | integer | Dzień miesiąca, w którym okres utrzymania ma wejść w życie. Używane tylko dla okresów miesięcznych. Przynajmniej jedna właściwość dayofweek lub day musi być określona dla okresów miesięcznych. |
| month | integer | Miesiące, w których okres utrzymania ma wejść w życie. Miesiące są przechowywane w formie binarnej, gdzie każdy bit reprezentuje odpowiedni miesiąc. Na przykład, 5 równa się 101 w systemie binarnym i oznacza, że utrzymanie będzie aktywowane w styczniu i marcu. Wymagane tylko dla okresów miesięcznych. |
Problem tag
Obiekt Problem tag służy do określenia, które problemy muszą być wytłumione, gdy okres utrzymania wejdzie w życie. Posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| tag (wymagane) |
string | Nazwa znacznika problemu. |
| operator | integer | Operator warunku. Możliwe wartości: 0 - Równa się; 2 - (domyślne) Zawiera. |
| value | string | Wartość znacznika problemu. |
Znaczniki mogą być określone tylko dla okresów utrzymania z kolekcją danych ("maintenance_type":0).