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 de 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 aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
groupids ID/array Retorna somente os cenários web que pertencem aos grupos de hosts especificados.
hostids ID/array Retorna somente os cenários web que pertencem aos hosts especificados.
httptestids ID/array Retorna somente os cenários web com os IDs especificados.
inherited boolean Se definido como true, retorna somente os cenários web herdados de um template.
monitored boolean Se definido como true, retorna somente os cenários web habilitados que pertencem a hosts monitorados.
templated boolean Se definido como true, retorna somente os cenários web que pertencem a templates.
templateids ID/array Retorna somente os cenários web que pertencem aos templates especificados.
expandName flag Expande macros no nome do cenário web.
expandStepName flag Expande macros nos nomes das etapas do cenário.
evaltype integer Método de avaliação das tags.

Valores possíveis:
0 - (padrão) E/OU;
2 - OU.
tags array Retorna somente os cenários web com as tags especificadas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Uma matriz vazia retorna todos os cenários web.

Valores possíveis de operador:
0 - (padrão) Contém;
1 - É igual a;
2 - Não contém;
3 - Não é igual a;
4 - Existe;
5 - Não existe.
selectHosts query Retorna os hosts aos quais o cenário web pertence como uma matriz 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 especificadas.

Valores possíveis: httptestid, name.
countOutput boolean Esses parâmetros estã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 countOutput tiver sido usado.

Exemplos

Recuperando um cenário web

Recupere todos os dados sobre o cenário web "9".

Request:

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

Origem

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