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	Omschrijving
groupids	string/array	Geef alleen webscenario's terug die behoren tot de opgegeven hostgroepen.
hostids	string/array	Geef alleen webscenario's terug die behoren tot de opgegeven hosts.
httptestids	string/array	Geef alleen webscenario's terug met de opgegeven ID's.
inherited	boolean	Indien ingesteld op `true`, geef alleen geërfde webscenario's terug van een sjabloon.
monitored	boolean	Indien ingesteld op `true`, geef alleen ingeschakelde webscenario's terug die behoren tot gemonitorde hosts.
templated	boolean	Indien ingesteld op `true`, geef alleen webscenario's terug die behoren tot sjablonen.
templateids	string/array	Geef alleen webscenario's terug die behoren tot de opgegeven sjablonen.
expandName	flag	Vervang macro's in de naam van het webscenario.
expandStepName	flag	Vervang macro's in de namen van stappen van het scenario.
evaltype	integer	Regels voor het zoeken op tags. Mogelijke waarden: 0 - (standaard) En/Of; 2 - Of.
tags	array van objecten	Geef alleen webscenario's terug met opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelige of hoofdletterongevoelige zoekopdracht op tag-waarde 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 aan; 2 - Niet zoals; 3 - Niet gelijk aan; 4 - Bestaat; 5 - Bestaat niet.
selectHosts	query	Geef de hosts waar het webscenario bij hoort terug als een array in de `hosts` eigenschap.
selectSteps	query	Geef webscenario-stappen terug in de `steps` eigenschap. Ondersteunt `count`.
selectTags	query	Geef webscenario-tags terug in de `tags` eigenschap.
sortfield	string/array	Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden: `httptestid`, `name`.
countOutput	boolean	Deze parameters, die gemeenschappelijk zijn voor alle `get`-methoden, worden in detail beschreven in het referentiecommentaar.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Het ophalen van een web scenario

Haal alle gegevens op over web scenario "4".

Request:

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

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "httptestid": "9",
                   "name": "Homepage controle",
                   "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": "Startpagina",
                           "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": "Startpagina / Over",
                           "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