httptest.get

Descripció

integer/array httptest.get(object parameters)

El mètode permet recuperar escenaris web segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre	Tipus	Descripció
groupids	string/array	Retorna només escenaris web que pertanyen als grups d'equips donats.
hostids	string/array	Retorna només escenaris web que pertanyen als equips donats.
httptestids	string/array	Retorna només escenaris web amb identificadors donats.
inherited	boolean	Si es defineix com a `true`, només retorna escenaris web heretats d'una plantilla.
monitored	boolean	Si s'estableix en `true`, només retorna els escenaris web activats que pertanyen als equips monitorats.
templed	boolean	Si s'estableix en `true`, només retorna escenaris web pertanyents a plantilles.
templateids	string/array	Retorna només escenaris web que pertanyen a les plantilles donades.
expandName	flag	Amplia les macros al nom de l'escenari web.
expandStepName	flag	Amplia les macros als noms de les passes dels escenaris.
evaltype	integer	Regles de cerca d'etiquetes. Valors possibles: 0 - (per defecte) I/O; 2 - O.
tags	array of objects	Retorna només escenaris web amb les etiquetes donades. Concordança exacta per etiqueta i cerca entre majúscules i minúscules o no per valor de l'etiqueta en funció del valor de l'operador. Format: `[{"tag": "<etiqueta>", "valor": "< valor>", " operador": "<operador>"}, ...]`. Una matriu buida retorna tots els escenaris web. Possibles tipus d'operadors: 0 - (per defecte) És com; 1 - Igual; 2 - No és com; 3 - No és igual 4 - Existeix; 5 - No existeix.
selectHosts	query	Retorna els equips als quals pertany l'escenari web com a matriu a la propietat equips.
selectSteps	query	Retorna les passes de l'escenari web a la propietat passes. Admet `count`.
selectTags	query	Retorna etiquetes d'escenari web a la propietat etiquetes.
sortfield	string/array	Ordena el resultat per propietats donades. Els valors possibles són: `httptestid` i `name`.
countOutput	boolean	Aquests paràmetres es descriuen als comentaris de referència.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valors de retorn

(integer/array) Retorna un d'entre:

una taula d'objectes;
el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar un escenari Web

Recuperar tota la informació de l'escenari Web "4".

Petició:

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

Resposta:

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

Veieu també

Font

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

Documentation