获取

描述

integer/array httptest.get(object parameters)

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

此方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看 User roles。

参数

(object) 定义期望输出的参数。

此方法支持以下参数。

参数类型描述
groupidsstring/array仅返回属于给定主机组的Web场景。
hostidsstring/array仅返回属于给定主机的Web场景。
httptestidsstring/array仅返回给定ID的Web场景。
inheritedboolean如果设置为true，仅返回从模板继承的Web场景。
monitoredboolean如果设置为true，仅返回属于被监控主机的可用Web场景。
templatedboolean如果设置为true，仅返回属于模板的Web场景。
templateidsstring/array仅返回属于给定模板的Web场景。
expandNameflag以Web场景的名称展开宏。
expandStepNameflag以场景步骤的名称展开宏。
evaltypeinteger用于标签搜索的规则。

可用值：
0 - (默认) And/Or；
2 - Or。
tagsarray of objects仅返回给定标签的Web场景。根据标签进行精确匹配，并根据运算符值按标签值进行区分大小写或不区分大小写的搜索。
格式：[{“tag”: “<tag>”, “value”: “<value>”, “operator”: “<operator>”}, …]。
一个空数组返回所有的Web场景。

可能的运算符类型：
0 - (默认) Like；
1 - Equal；
2 - Not like；
3 - Not equal；
4 - Exists；
5 - Not exists。
selectHostsquery在hosts属性中，以一个数组的方式返回Web场景所属的主机。
selectStepsquery在steps属性中返回Web场景步骤。

支持count。
selectTagsquery在tags属性中返回Web场景标签。
sortfieldstring/array按照给定属性对结果进行排序。

可能的值：httptestid和name。
countOutputboolean这些参数对所有get方法是公共的，详细描述请参见参考说明 。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回以下其中一种结果：

  • 一个对象数组；
  • 如果使用了参数countOutput，则返回检索到的对象的数量。

示例

检索一个Web场景

检索关于Web场景“4”的所有数据。

请求：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "httptest.get",
  4.            "params": {
  5.                "output": "extend",
  6.                "selectSteps": "extend",
  7.                "httptestids": "9"
  8.            },
  9.            "auth": "038e1d7b1735c6a5436ee9eae095879e",
  10.            "id": 1
  11.        }

响应：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "httptestid": "9",
  6.                    "name": "Homepage check",
  7.                    "nextcheck": "0",
  8.                    "delay": "1m",
  9.                    "status": "0",
  10.                    "variables": [],
  11.                    "agent": "Zabbix",
  12.                    "authentication": "0",
  13.                    "http_user": "",
  14.                    "http_password": "",
  15.                    "hostid": "10084",
  16.                    "templateid": "0",
  17.                    "http_proxy": "",
  18.                    "retries": "1",
  19.                    "ssl_cert_file": "",
  20.                    "ssl_key_file": "",
  21.                    "ssl_key_password": "",
  22.                    "verify_peer": "0",
  23.                    "verify_host": "0",
  24.                    "headers": [],
  25.                    "steps": [
  26.                        {
  27.                            "httpstepid": "36",
  28.                            "httptestid": "9",
  29.                            "name": "Homepage",
  30.                            "no": "1",
  31.                            "url": "http://example.com",
  32.                            "timeout": "15s",
  33.                            "posts": "",
  34.                            "required": "",
  35.                            "status_codes": "200",
  36.                            "variables": [  
  37.                                {  
  38.                                    "name":"{var}",
  39.                                    "value":"12"
  40.                                }
  41.                            ],
  42.                            "follow_redirects": "1",
  43.                            "retrieve_mode": "0",
  44.                            "headers": [],
  45.                            "query_fields": []
  46.                        },
  47.                        {
  48.                            "httpstepid": "37",
  49.                            "httptestid": "9",
  50.                            "name": "Homepage / About",
  51.                            "no": "2",
  52.                            "url": "http://example.com/about",
  53.                            "timeout": "15s",
  54.                            "posts": "",
  55.                            "required": "",
  56.                            "status_codes": "200",
  57.                            "variables": [],
  58.                            "follow_redirects": "1",
  59.                            "retrieve_mode": "0",
  60.                            "headers": [],
  61.                            "query_fields": []
  62.                        }
  63.                    ]
  64.                }
  65.            ],
  66.            "id": 1
  67.        }

参见

来源

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