httptest.get

Opis

integer/array httptest.get(object parameters)

Ta metoda umożliwia pobieranie scenariuszy WWW zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji znajduje się w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
groupids ID/array Zwraca tylko scenariusze web należące do określonych grup hostów.
hostids ID/array Zwraca tylko scenariusze web należące do określonych hostów.
httptestids ID/array Zwraca tylko scenariusze web o określonych identyfikatorach.
inherited boolean Jeśli ustawiono true, zwraca tylko scenariusze web odziedziczone z szablonu.
monitored boolean Jeśli ustawiono true, zwraca tylko włączone scenariusze web należące do monitorowanych hostów.
templated boolean Jeśli ustawiono true, zwraca tylko scenariusze web należące do szablonów.
templateids ID/array Zwraca tylko scenariusze web należące do określonych szablonów.
expandName flag Rozwija makra w nazwie scenariusza web.
expandStepName flag Rozwija makra w nazwach kroków scenariusza.
evaltype integer Metoda oceny tagów.

Możliwe wartości:
0 - (domyślnie) And/Or;
2 - Or.
tags array Zwraca tylko scenariusze web z określonymi tagami.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie scenariusze web.

Możliwe wartości operatora:
0 - (domyślnie) Zawiera;
1 - Jest równe;
2 - Nie zawiera;
3 - Nie jest równe;
4 - Istnieje;
5 - Nie istnieje.
selectHosts query Zwraca hosty, do których należy scenariusz web, jako tablicę we właściwości hosts.
selectSteps query Zwraca kroki scenariusza web we właściwości steps.

Obsługuje count.
selectTags query Zwraca tagi scenariusza web we właściwości tags.
sortfield string/array Sortuje wynik według określonych właściwości.

Możliwe wartości: httptestid, name.
countOutput boolean Te parametry opisano 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:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli został użyty parametr countOutput.

Przykłady

Pobieranie scenariusza webowego

Pobierz wszystkie dane dotyczące scenariusza webowego "9".

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "httptest.get",
    "params": {
        "output": "extend",
        "selectSteps": "extend",
        "httptestids": "9"
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "httptestid": "9",
            "name": "Homepage check",
            "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.