httptest.get

Leírás

integer/array httptest.get(objektumparaméterek)

A metódus lehetővé teszi webes forgatókönyvek lekérését a megadottak szerint paramétereket.

Ez a módszer bármilyen típusú felhasználó számára elérhető. Engedélyek A metódus meghívása a felhasználói szerepkör beállításaiban visszavonható. Lásd: User roles további információért.

Paraméterek

(object) A kívánt kimenetet meghatározó paraméterek.

A módszer a következő paramétereket támogatja.

Paraméter Típus Leírás
groupids string/array Csak az adott gazdagépcsoportokhoz tartozó webes forgatókönyveket adja vissza.
hostids string/array Csak az adott gazdagéphez tartozó webes forgatókönyveket adja vissza.
httptestids string/array Csak a megadott azonosítókkal rendelkező webes forgatókönyveket adja vissza.
herited boolean Ha true-ra van állítva, csak a sablonból örökölt webes forgatókönyveket adja vissza.
monitored boolean Ha true-ra van állítva, csak a felügyelt gazdagépekhez tartozó engedélyezett webes forgatókönyveket adja vissza.
template boolean Ha true-ra van állítva, csak a sablonokhoz tartozó webes forgatókönyveket adja vissza.
templateids string/array Csak az adott sablonokhoz tartozó webes forgatókönyveket adja vissza.
expandName flag Makrók kibontása a webes forgatókönyv nevében.
expandStepName flag Makrók kibontása a forgatókönyv lépéseinek nevében.
evaltype integer A címkekeresés szabályai.

Lehetséges értékek:
0 - (alapértelmezett) és/vagy;
2 - Or.
címkék objektumtömb Csak a webes forgatókönyveket adja vissza megadott címkékkel. Pontos egyezés címke szerint és kis- és nagybetűk közötti keresés címkeérték alapján az operátor értékétől függően.
Formátum: [{"tag": "<címke>", "érték": "<érték>", " operátor": "<operátor>"}, ...].
Egy üres tömb az összes webes forgatókönyvet adja vissza.

Lehetséges operátortípusok:
0 - (alapértelmezett) Tetszik;
1 - Egyenlő;
2 - Nem tetszik;
3 - Nem egyenlő
4 - Létezik;
5 - Nem létezik.
selectHosts query Tömbként adja vissza azokat a gazdagépeket, amelyekhez a webes forgatókönyv tartozik a hosts tulajdonságban.
selectSteps query A webes forgatókönyv lépéseit adja vissza a steps tulajdonságban.

Támogatja a count-t.
selectTags query Vissza vissza a webes forgatókönyv címkéit a tags tulajdonságban.
sortfield string/array Rendezd az eredményt a megadott tulajdonságok szerint.

A lehetséges értékek: httptestid és name.
countOutput boolean Ezek a paraméterek, amelyek minden get metódusnál közösek, a referenciakommentár részben találhatók.
szerkeszthető logikai
excludeSearch logikai
szűrő objektum
korlát egész szám
kimenet lekérdezés
preservekeys boolean
kereső objektum
searchByAny boolean
searchWildcardsEnabled boolean
sortorder karakterlánc/tömb
startSearch boolean

Visszatérési értékek

(integer/array) A következőket adja vissza:

  • objektumok tömbje;
  • a letöltött objektumok száma, ha a countOutput paraméter rendelkezik használtak.

Példák

Retrieving a web scenario

Retrieve all data about web scenario "4".

Request:

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

Response:

{
    "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
}

Lásd még

Forrás

CHttpTest::get() az ui/include/classes/api/services/CHttpTest.php-ban.