Documentation
Table of Contents
> Obiekt Web scenario
Następjące obiekty są bezpośrednio związane z API webcheck.
Web scenario
Obiekt Web scenario ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| httptestid | string | (readonly) ID scenariusza sieci WWW. |
| hostid (wymagane) |
string | ID hosta, do którego należy scenariusz sieci WWW. |
| name (wymagane) |
string | Nazwa scenariusza sieci WWW. |
| agent | string | Ciąg identyfikujący agenta użytkownika, który będzie używany przez scenariusz sieci WWW. Domyślnie: Zabbix |
| authentication | integer | Metoda uwierzytelniania, która będzie używana przez scenariusz sieci WWW. Możliwe wartości: 0 - (domyślnie) brak; 1 - uwierzytelnianie podstawowe HTTP; 2 - uwierzytelnianie NTLM. |
| delay | string | Interwał wykonywania scenariusza sieci WWW. Akceptuje sekundy, jednostki czasu z sufiksem oraz makro użytkownika. Domyślnie: 1m. |
| headers | tablica pól HTTP | Nagłówki HTTP, które zostaną wysłane podczas wykonywania żądania. |
| http_password | string | Hasło używane do uwierzytelniania podstawowego HTTP lub NTLM. |
| http_proxy | string | Serwer proxy, który będzie używany przez scenariusz sieci WWW podany jako http://[użytkownik[:hasło]@]proxy.example.com[:port]. |
| http_user | string | Nazwa użytkownika używana do uwierzytelniania podstawowego HTTP lub NTLM. |
| nextcheck | znacznik czasu | (tylko do odczytu) Czas następnego wykonania scenariusza sieci WWW. |
| retries | liczba całkowita | Liczba prób wykonania każdego kroku scenariusza sieci WWW przed niepowodzeniem. Domyślnie: 1. |
| ssl_cert_file | string | Nazwa pliku certyfikatu SSL używanego do uwierzytelniania klienta (musi być w formacie PEM). |
| ssl_key_file | string | Nazwa pliku klucza prywatnego SSL używanego do uwierzytelniania klienta (musi być w formacie PEM). |
| ssl_key_password | string | Hasło klucza prywatnego SSL. |
| status | liczba całkowita | Określa, czy scenariusz sieci WWW jest włączony. Możliwe wartości: 0 - (domyślnie) włączony; 1 - wyłączony. |
| templateid | string | (tylko do odczytu) ID nadrzędnego szablonu scenariusza sieci WWW. |
| variables | tablica pól HTTP | Zmienne scenariusza sieci WWW. |
| verify_host | liczba całkowita | Określa, czy należy sprawdzić, czy nazwa hosta dla połączenia odpowiada tej w certyfikacie hosta. Możliwe wartości: 0 - (domyślnie) pomijaj weryfikację hosta; 1 - sprawdź hosta. |
| verify_peer | liczba całkowita | Określa, czy należy zweryfikować autentyczność certyfikatu hosta. Możliwe wartości: 0 - (domyślnie) pomijaj weryfikację podmiotu; 1 - zweryfikuj podmiot. |
| uuid | string | Uniwersalny globalny identyfikator, używany do łączenia importowanych scenariuszy sieci WWW z już istniejącymi. Używane tylko dla scenariuszy sieci WWW na szablonach. |
Zauważ, że dla niektórych metod (update, delete) kombinacja parametrów wymaganych/opcjonalnych jest inna.
Web scenario tag
Obiekt Web scenario tag ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| tag (wymagane) |
string | Nazwa znacznika scenariusza sieci WWW. |
| value | string | Wartość znacznika scenariusza sieci WWW. |
Scenario step
Obiekt Scenario step definiuje konkretne sprawdzenie scenariusza sieci WWW. Posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| httpstepid | string | (tylko do odczytu) ID kroku scenariusza. |
| name (wymagane) |
string | Nazwa kroku scenariusza. |
| no (wymagane) |
integer | Numer sekwencyjny kroku w scenariuszu internetowym. |
| url (wymagane) |
string | Adres URL do sprawdzenia. |
| follow_redirects | integer | Czy podążać za przekierowaniami HTTP. Możliwe wartości to: 0 - nie podążaj za przekierowaniami; 1 - (domyślne) podążaj za przekierowaniami. |
| headers | tablica pól HTTP | Nagłówki HTTP, które zostaną wysłane podczas wykonywania żądania. Nagłówki kroku scenariusza nadpisują nagłówki określone dla scenariusza WWW. |
| httptestid | string | (tylko do odczytu) ID scenariusza WWW, do którego należy krok. |
| posts | string tablica pól HTTP |
Zmienne POST HTTP jako łańcuch (surowe dane POST) lub jako tablica pól HTTP (dane pola formularza). |
| required | string | Tekst, który musi być obecny w odpowiedzi. |
| retrieve_mode | integer | Część odpowiedzi HTTP, którą krok scenariusza musi pobrać. Możliwe wartości to: 0 - (domyślne) tylko treść; 1 - tylko nagłówki; 2 - nagłówki i treść. |
| status_codes | string | Zakresy wymaganych kodów stanu HTTP oddzielone przecinkami. |
| timeout | string | Limit czasu żądania w sekundach. Akceptuje sekundy, jednostki czasu z przyrostkiem i makro użytkownika. Domyślnie: 15s. Maksymalnie: 1h. Minimalnie: 1s. |
| variables | tablica pól HTTP | Zmienne kroku scenariusza. |
| query_fields | tablica pól HTTP | Pola zapytań - tablica pól HTTP, które zostaną dodane do adresu URL podczas wykonywania żądania. |
HTTP field
Obiekt HTTP field definiuje nazwę i wartość, która jest używana do określenia zmiennej, nagłówka HTTP, danych pola formularza POST lub danych pola zapytania. Posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| name (wymagane) |
string | Nazwa nagłówka / zmiennej / pola POST lub GET. |
| value (wymagane) |
string | Wartość nagłówka / zmiennej / pola POST lub GET. |