Sidebar

2022 Zabbix中国峰会
2022 Zabbix中国峰会

httptest.get

说明

integer/array httptest.get(object parameters)

该方法允许根据给定的参数检索Web场景。

Description

integer/array httptest.get(object parameters)

The method allows to retrieve web scenarios according to the given parameters.

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数 类 描述
applicationids string/array 仅返回属于给定应用程序的Web场景。
groupids string/array 仅返回属于给定主机组的Web方案。
hostids string/array 仅返回属于给定主机的Web场景。
httptestids string/array 只返回具有给定ID的Web场景。
inherited boolean 如果设置为“true”,只返回从模板继承的Web场景。
monitored boolean 如果设置为“true”,则只返回属于受监视主机的启用的Web场景。
templated boolean 如果设置为“true”,则只返回属于模板的Web场景。
templateids string/array 仅返回属于给定模板的Web场景
expandName flag 以Web方案的名称展开宏。
expandStepName flag 在方案步骤的名称中展开宏。
selectHosts query 将网站场景所属的主机作为“hosts”属性中的数组返回.
selectSteps query steps属性中返回Web方案步骤。
sortfield string/array 按照给定的属性对结果进行排序。

可能的值为:httptestidname
countOutput flag 这些参数对于所有的“get”方法是常见的,在参考. 中有详细描述
editable boolean
excludeSearch flag
filter object
limit integer
output query
preservekeys flag
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch flag

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
applicationids string/array Return only web scenarios that belong to the given applications.
groupids string/array Return only web scenarios that belong to the given host groups.
hostids string/array Return only web scenarios that belong to the given hosts.
httptestids string/array Return only web scenarios with the given IDs.
inherited boolean If set to true return only web scenarios inherited from a template.
monitored boolean If set to true return only enabled web scenarios that belong to monitored hosts.
templated boolean If set to true return only web scenarios that belong to templates.
templateids string/array Return only web scenarios that belong to the given templates.
expandName flag Expand macros in the name of the web scenario.
expandStepName flag Expand macros in the names of scenario steps.
selectHosts query Return the host that the web scenario belongs to as an array in the hosts property.
selectSteps query Return web scenario steps in the steps property.
sortfield string/array Sort the result by the given properties.

Possible values are: httptestid and name.
countOutput boolean These parameters being common for all get methods are described in detail in the reference commentary.
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”参数,则检索到的对象的计数。

Return values

(integer/array) Returns either:

  • an array of objects;
  • the count of retrieved objects, if the countOutput parameter has been used.

示例

检索网络场景

Examples

Retrieving a web scenario

Retrieve all data about web scenario "4".

Request:

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

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "httptestid": "9",
                   "name": "Homepage check",
                   "applicationid": "0",
                   "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://mycompany.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://mycompany.com/about",
                           "timeout": "15s",
                           "posts": "",
                           "required": "",
                           "status_codes": "200",
                           "variables": [],
                           "follow_redirects": "1",
                           "retrieve_mode": "0",
                           "headers": [],
                           "query_fields": []
                       }
                   ]
               }
           ],
           "id": 1
       }

参考

来源

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