httptest.get

Beschrijving

integer/array httptest.get(objectparameters)

De methode maakt het mogelijk om webscenario's op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
groupids	string/array	Retourneer alleen webscenario's die bij de opgegeven hostgroepen horen.
hostids	string/array	Retourneer alleen webscenario's die bij de opgegeven hosts horen.
httptestids	string/array	Retourneer alleen webscenario's met de opgegeven ID's.
inherited	boolean	Indien ingesteld op `true`, worden alleen webscenario's geretourneerd die zijn overgenomen van een sjabloon.
monitored	boolean	Indien ingesteld op `true` retourneert u alleen ingeschakelde webscenario's die behoren tot gecontroleerde hosts.
template	boolean	Indien ingesteld op `true`, worden alleen webscenario's geretourneerd die bij sjablonen horen.
templateids	string/array	Retourneer alleen webscenario's die bij de opgegeven sjablonen horen.
expandName	flag	Macro's uitvouwen in de naam van het webscenario.
expandStepName	flag	Macro's uitvouwen in de namen van scenariostappen.
evaltype	integer	Regels voor het zoeken naar tags. Mogelijke waarden: 0 - (standaard) And/Or; 2 - Or.
tags	array of objects	Retourneer alleen webscenario's met opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelig of hoofdletterongevoelig zoeken op tagwaarde, afhankelijk van de operatorwaarde. Formaat: `[{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...]`. Een lege array retourneert alle webscenario's. Mogelijke operatortypen: 0 - (standaard) Like; 1 - Gelijk; 2 - Niet zoals; 3 - Niet gelijk 4 - Bestaat; 5 - Bestaat niet.
selectHosts	query	Retourneer de hosts waartoe het webscenario behoort als een array in de eigenschap hosts.
selectSteps	query	Retourneer webscenariostappen in de steps eigenschap. Ondersteunt `count`.
selectTags	query	Retourneer de webscenario-tags in de eigenschap tags.
sortfield	string/array	Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: `httptestid` en `name`.
countOutput	boolean	Deze parameters gelden voor alle `get`-methoden en worden in detail beschreven in de referentiecommentaar.
editable	booleaans
excludeSearch	boolean
filter	object
limiet	geheel getal
uitvoer	query
preservekeys	boolean
zoeken	object
searchByAny	boolean
searchWildcardsIngeschakeld	boolean
sortorde	string/array
startZoeken	booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Een webscenario ophalen

Haal alle gegevens op over webscenario "4".

Verzoek:

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

Antwoord:

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

Zie ook

Bron

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

Documentation