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 WWW należące do podanych grup hostów.
hostids ID/array Zwraca tylko scenariusze WWW należące do podanych hostów.
httptestids ID/array Zwraca tylko scenariusze WWW o podanych identyfikatorach.
inherited boolean Jeśli ustawiono na true, zwraca tylko scenariusze WWW odziedziczone z szablonu.
inheritedTags boolean Zwraca scenariusze WWW, które mają podane tags również w szablonie/hoście/podłączonych szablonach.

Możliwe wartości:
true - szablon/host/podłączone szablony również muszą mieć podane tagi;
false - (domyślnie) tagi z szablonu/hosta/podłączonych szablonów są ignorowane.
monitored boolean Jeśli ustawiono na true, zwraca tylko włączone scenariusze WWW należące do monitorowanych hostów.
selectInheritedTags query Zwraca właściwość inheritedTags z tagami znajdującymi się w szablonie/hoście/podłączonych szablonach.
templated boolean Jeśli ustawiono na true, zwraca tylko scenariusze WWW należące do szablonów.
templateids ID/array Zwraca tylko scenariusze WWW należące do podanych szablonów.
expandName flag Rozwija makra w nazwie scenariusza WWW.
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 WWW z podanymi tagami.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie scenariusze WWW.

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

Obsługuje count.
selectTags query Zwraca tagi scenariusza WWW we właściwości tags.
sortfield string/array Sortuje wynik według podanych 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 WWW

Pobierz wszystkie dane o scenariuszu WWW „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",
            "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",
            "uuid": "",
            "headers": [],
            "variables": [],
            "steps": [
                {
                    "httpstepid": "36",
                    "httptestid": "9",
                    "name": "Homepage",
                    "no": "1",
                    "url": "http://example.com",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "post_type": "1",
                    "headers": [],
                    "variables": [
                        {
                            "name":"{var}",
                            "value":"12"
                        }
                    ],
                    "query_fields": []
                },
                {
                    "httpstepid": "37",
                    "httptestid": "9",
                    "name": "Homepage / About",
                    "no": "2",
                    "url": "http://example.com/about",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "post_type": "1",
                    "headers": [],
                    "variables": [],
                    "query_fields": []
                }
            ]
        }
    ],
    "id": 1
}

Zobacz także

Źródło

CHttpTest::get() w ui/include/classes/api/services/CHttpTest.php.