Documentation
Table of Contents
httptest.get
Opis
integer/array httptest.get(object parameters)
Metoda umożliwia pobranie scenariuszy internetowych zgodnie z określonymi parametrami.
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do jej wywołania mogą zostać cofnięte w ustawieniach ról użytkownika. Zobacz Role użytkowników , aby uzyskać więcej informacji.
Parametry
(object) Parametry definiujące pożądany wynik.
Metoda obsługuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| groupids | string/array | Zwraca tylko scenariusze sieci WWW należące do określonych grup hostów. |
| hostids | string/array | Zwraca tylko scenariusze sieci WWW należące do określonych hostów. |
| httptestids | string/array | Zwraca tylko scenariusze sieci WWW o podanych identyfikatorach. |
| inherited | boolean | Jeśli ustawione na true, zwraca tylko scenariusze sieci WWW odziedziczone z szablonu. |
| monitored | boolean | Jeśli ustawione na true, zwraca tylko włączone scenariusze sieci WWW należące do monitorowanych hostów. |
| templated | boolean | Jeśli ustawione na true, zwraca tylko scenariusze sieci WWW należące do szablonów. |
| templateids | string/array | Zwraca tylko scenariusze sieci WWW należące do określonych szablonów. |
| expandName | flag | Rozwiń makra w nazwie scenariusza sieci WWW. |
| expandStepName | flag | Rozwiń makra w nazwach kroków scenariusza. |
| evaltype | integer | Zasady wyszukiwania znaczników. Możliwe wartości: 0 - (domyślnie) I/Lub; 2 - Lub. |
| tags | array of objects | Zwraca tylko scenariusze sieci WWW z określonymi znacznikami. Dokładne dopasowanie według tagu i wyszukiwanie uwzględniające wielkość liter lub niezależne od wielkości liter w zależności od wartości operatora. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Pusta tablica zwraca wszystkie scenariusze internetowe. Możliwe typy operatorów: 0 - (domyślnie) Zawiera; 1 - jest równy; 2 - Nie zawiera; 3 - Nie jest równy 4 - Istnieje; 5 - Nie istnieje. |
| selectHosts | query | Zwraca hosty, do których należy scenariusz sieci WWW, jako tablicę w właściwości hosts. |
| selectSteps | query | Zwraca kroki scenariusza sieci WWW w właściwości steps. Obsługuje count. |
| selectTags | query | Zwraca znaczniki scenariusza sieci WWW w właściwości tags. |
| sortfield | string/array | Sortuje wynik według podanych właściwości. Możliwe wartości to: httptestid i name. |
| countOutput | boolean | Parametry te, będąc wspólne dla wszystkich metod get, są szczegółowo opisane w komentarzu referencyjnym. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Zwracane wartości
(integer/array) Zwraca jedną z opcji:
- tablicę obiektów;
- liczbę pobranych obiektów, jeśli parametr
countOutputzostał wykorzystany.
Przykłady
Pobieranie scenariusza sieci WWW
Pobierz wszystkie dane dotyczące scenariusza sieci WWW "4".
Zapytanie:
{ "jsonrpc": "2.0", "method": "httptest.get", "params": { "output": "extend", "selectSteps": "extend", "httptestids": "9" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Odpowiedź:
{ "jsonrpc": "2.0", "result": [ { "httptestid": "9", "name": "Homepage check", "nextcheck": "0", "delay": "1m", "status": "0", "variables": [], "agent": "Zabbix", "authentication": "0", "http_user": "", "http_password": "", "hostid": "10084", "templateid": "0", "http_proxy": "", "retries": "1", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "headers": [], "steps": [ { "httpstepid": "36", "httptestid": "9", "name": "Homepage", "no": "1", "url": "http://example.com", "timeout": "15s", "posts": "", "required": "", "status_codes": "200", "variables": [ { "name":"{var}", "value":"12" } ], "follow_redirects": "1", "retrieve_mode": "0", "headers": [], "query_fields": [] }, { "httpstepid": "37", "httptestid": "9", "name": "Homepage / About", "no": "2", "url": "http://example.com/about", "timeout": "15s", "posts": "", "required": "", "status_codes": "200", "variables": [], "follow_redirects": "1", "retrieve_mode": "0", "headers": [], "query_fields": [] } ] } ], "id": 1 }Zobacz także
Źródło
CHttpTest::get() w ui/include/classes/api/services/CHttpTest.php.