httptest.get

Описание

целое число/массив httptest.get(объект параметры)

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

Параметры

(объект) Параметры задают желаемый вывод.

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

Параметр Тип Тип
applicationids строка/массив Возврат только тех веб-сценариев, которые принадлежат заданным группам элементов данных.
groupids строка/массив Возврат только тех веб-сценариев, которые принадлежат заданным группам узлов сети.
hostids строка/массив Возврат только тех веб-сценариев, которые принадлежат заданным узлам сети.
httptestids строка/массив Возврат веб-сценариев только с заданными ID.
inherited логический Если задано значение true, возвращать веб-сценарии уснаследованные из шаблона.
monitored логический Если задано значение true, возвращать только активированные веб-сценарии с узлов сети под наблюдением.
templated логический Если задано значение true, возвращать только те веб-сценарии, которые принадлежат шаблонам.
templateids строка/массив Возврат только тех веб-сценариев, которые принадлежат заданным шаблонам.
expandName флаг Раскрытие макросов в имени веб-сценария.
expandStepName флаг Раскрытие макросов в именах шагов сценария.
selectHosts запрос Возврат узлов сети, которым принадлежит веб-сценарий, в виде массива в свойстве hosts.
selectSteps запрос Возврат шагов веб-сценария в свойстве steps.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

Возможные значения: httptestid и name.
countOutput флаг Эти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch флаг
filter объект
limit целое число
output запрос
preservekeys флаг
search объект
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch флаг

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

(целое число/массив) Возвращает либо:

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

Примеры

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

Получение всех данных веб-сценария "4".

Запрос:

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

Ответ:

{  "jsonrpc": "2.0",  "result": [  {  "httptestid": "9",  "name": "Homepage check",  "applicationid": "0",  "nextcheck": "0",  "delay": "60",  "status": "0",  "variables": "",  "agent": "",  "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://mycompany.com",  "timeout": "15",  "posts": "",  "required": "",  "status_codes": "200",  "variables": "",  "follow_redirects": "1",  "retrieve_mode": "0",  "headers": ""  },  {  "httpstepid": "37",  "httptestid": "9",  "name": "Homepage / About",  "no": "2",  "url": "http://mycompany.com/about",  "timeout": "15",  "posts": "",  "required": "",  "status_codes": "200",  "variables": "",  "follow_redirects": "1",  "retrieve_mode": "0",  "headers": ""  }  ]  }  ],  "id": 1 }

Смотрите также

Исходный код

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