httptest.get

Описание

integer/array httptest.get(object parameters)

Этот метод позволяет получать веб-сценарии в соответствии с заданными параметрами.

Этот метод доступен пользователям любого типа. Разрешения на вызов метода могут быть отозваны в настройках роли пользователя. Дополнительную информацию смотрите в разделе Роли пользователей.

Параметры

(object) Параметры, определяющие желаемый вывод.

Метод поддерживает следующие параметры.

Параметр Тип Описание
groupids ID/array Возвращать только веб-сценарии, принадлежащие указанным группам узлов сети.
hostids ID/array Возвращать только веб-сценарии, принадлежащие указанным узлам сети.
httptestids ID/array Возвращать только веб-сценарии с указанными ID.
inherited boolean Если установлено значение true, возвращать только веб-сценарии, унаследованные от шаблона.
inheritedTags boolean Возвращать веб-сценарии, у которых указанные tags также присутствуют в шаблоне/узле сети/связанных шаблонах.

Возможные значения:
true — шаблон/узел сети/связанные шаблоны также должны иметь указанные теги;
false — (по умолчанию) теги из шаблона/узла сети/связанных шаблонов игнорируются.
monitored boolean Если установлено значение true, возвращать только включённые веб-сценарии, принадлежащие отслеживаемым узлам сети.
selectInheritedTags query Возвращать свойство inheritedTags с тегами, которые присутствуют в шаблоне/узле сети/связанных шаблонах.
templated boolean Если установлено значение true, возвращать только веб-сценарии, принадлежащие шаблонам.
templateids ID/array Возвращать только веб-сценарии, принадлежащие указанным шаблонам.
expandName flag Разворачивать макросы в имени веб-сценария.
expandStepName flag Разворачивать макросы в именах шагов сценария.
evaltype integer Метод вычисления тегов.

Возможные значения:
0 — (по умолчанию) И/Или;
2 — Или.
tags array Возвращать только веб-сценарии с указанными тегами.
Формат: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Пустой массив возвращает все веб-сценарии.

Возможные значения operator:
0 — (по умолчанию) Содержит;
1 — Равно;
2 — Не содержит;
3 — Не равно;
4 — Существует;
5 — Не существует.
selectHosts query Возвращать узлы сети, которым принадлежит веб-сценарий, в виде массива в свойстве hosts.
selectSteps query Возвращать шаги веб-сценария в свойстве steps.

Поддерживает count.
selectTags query Возвращать теги веб-сценария в свойстве tags.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: httptestid, name.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Возвращаемые значения

(integer/array) Возвращает одно из следующего:

  • массив объектов;
  • количество полученных объектов, если был использован параметр countOutput.

Примеры

Получение веб-сценария

Получить все данные о веб-сценарии "9".

Запрос:

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

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "httptestid": "9",
            "name": "Homepage check",
            "delay": "1m",
            "status": "0",
            "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",
            "uuid": "",
            "headers": [],
            "variables": [],
            "steps": [
                {
                    "httpstepid": "36",
                    "httptestid": "9",
                    "name": "Homepage",
                    "no": "1",
                    "url": "http://example.com",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "post_type": "1",
                    "headers": [],
                    "variables": [
                        {
                            "name":"{var}",
                            "value":"12"
                        }
                    ],
                    "query_fields": []
                },
                {
                    "httpstepid": "37",
                    "httptestid": "9",
                    "name": "Homepage / About",
                    "no": "2",
                    "url": "http://example.com/about",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "post_type": "1",
                    "headers": [],
                    "variables": [],
                    "query_fields": []
                }
            ]
        }
    ],
    "id": 1
}

См. также

Источник

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