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: Áú»¢¶Ä²© |
| 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. |