Documentation
Table of Contents
httptest.get
Descrição
integer/array httptest.get(object parameters)
O método permite recuperar cenários web de acordo com os parâmetros fornecidos.
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte Funções de usuário para mais informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| groupids | ID/array | Retorna apenas cenários web que pertencem aos grupos de hosts fornecidos. |
| hostids | ID/array | Retorna apenas cenários web que pertencem aos hosts fornecidos. |
| httptestids | ID/array | Retorna apenas cenários web com os IDs fornecidos. |
| inherited | boolean | Se definido como true, retorna apenas cenários web herdados de um template. |
| monitored | boolean | Se definido como true, retorna apenas cenários web habilitados que pertencem a hosts monitorados. |
| templated | boolean | Se definido como true, retorna apenas cenários web que pertencem a templates. |
| templateids | ID/array | Retorna apenas cenários web que pertencem aos templates fornecidos. |
| expandName | flag | Expande macros no nome do cenário web. |
| expandStepName | flag | Expande macros nos nomes das etapas do cenário. |
| evaltype | integer | Regras para busca de tags. Valores possíveis: 0 - (padrão) E/Ou 2 - Ou |
| tags | array | Retorna apenas cenários web com as tags fornecidas. Correspondência exata por tag e busca sensível ou não a maiúsculas/minúsculas pelo valor da tag, dependendo do valor do operador. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Um array vazio retorna todos os cenários web. Tipos de operadores possíveis: 0 - (padrão) Contém (correspondência de substring, não sensível a maiúsculas/minúsculas) 1 - Igual (sensível a maiúsculas/minúsculas) 2 - Não contém (correspondência de substring, não sensível a maiúsculas/minúsculas) 3 - Diferente (sensível a maiúsculas/minúsculas) 4 - Existe 5 - Não existe |
| selectHosts | query | Retorna os hosts aos quais o cenário web pertence como um array na propriedade hosts. |
| selectSteps | query | Retorna as etapas do cenário web na propriedade steps.Suporta count. |
| selectTags | query | Retorna as tags do cenário web na propriedade tags. |
| sortfield | string/array | Ordena o resultado pelas propriedades fornecidas. Valores possíveis: httptestid, name. |
| countOutput | boolean | Esses parâmetros são descritos no comentário 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 |
Valores de retorno
(integer/array) Retorna:
- um array de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputfoi usado.
Exemplos
Recuperando um cenário web
Recupere todos os dados sobre o cenário web "9".
{
"jsonrpc": "2.0",
"method": "httptest.get",
"params": {
"output": "extend",
"selectSteps": "extend",
"httptestids": "9"
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"httptestid": "9",
"name": "Homepage check",
"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
}Veja também
Fonte
CHttpTest::get() in ui/include/classes/api/services/CHttpTest.php.