service.get

service.get

描述

integer/array service.get(object parameters)

此方法允许根据给定的参数检索服务。

此方法允许任何用户使用。可以在用户角色设置中撤销调用此方法的权限。更多信息请查看用户角色。

参数

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

此方法支持以下参数。

参数	类型
serviceids	string/array	仅返回给定ID对应的服务。
parentids	string/array	仅返回与给定父服务相关的服务。
deep_parentids	flag	与`parentids`一起使用，返回所有直接和间接的子服务。
childids	string/array	仅返回与给定子服务相关的服务。
evaltype	integer	标记搜索规则。可能的值： 0 - (默认) 与/或； 2 - 或。
tags	object/array of objects	仅返回带给定标记的服务。根据标记进行精确匹配，或根据标记值的运算符运算进行区分或不区分大小写的搜索。格式： `[{“tag”: “<tag>”, “value”: “<value>”, “operator”: “<operator>”}, …]`. 空的数组返回所有服务。可能的运算符: 0 - (默认) 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。
problem_tags	object/array of objects	仅返回带给定问题标记的服务。根据标记进行精确匹配，或根据标记值的运算符运算进行区分或不区分大小写的搜索。格式：`[{“tag”: “<tag>”, “value”: “<value>”, “operator”: “<operator>”}, …]`. 空的数组返回所有服务。可能的运算符值： 0 - (默认) 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。
without_problem_tags	flag	仅返回不带问题标记的服务。
slaids	string/array	仅返回与特定SLA关联的服务。
selectChildren	query	返回`children`属性为子服务。支持`count`。
selectParents	query	返回`parents`属性为父服务。支持`count`.
selectTags	query	返回tags 属性为服务标记。支持`count`.
selectProblemEvents	query	返回`problem_events`属性为问题事件对象数组。问题事件对象有如下属性： `eventid` - (字符串) 事件ID； `severity` - (字符串) 当前事件严重性； `name` - (字符串) 已解决的事件名称。支持`count`。
selectProblemTags	query	返回problem_tags属性为问题标记。支持`count`。
selectStatusRules	query	返回status_rules属性为状态规则。支持`count`。
selectStatusTimeline	object/array of objects	返回`status_timeline`属性包含给定时期内服务状态改变。格式`[{“period_from”: “<period_from>”, “period_to”: “<period_to>”}, …]` - 以`period_from`为开始日期 (包含; 整型时间戳)，`period_to`为结束日期 (不含;整型时间戳)确定你需要的时间段。返回一个包含`start_value`属性的实体数组以及一个特定时间内状态改变的警告数组。

sortfield	string/array	根据给定属性将结果排序。可能的值： `serviceid`， `name`， `status`， `sortorder` 和 `created_at`。
countOutput	boolean	这些参数与所有的`get`方法相同，详情见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

返回值

(整型/数组) 返回其中之一：

一个对象数组；
如果使用countOutput参数，被检索对象的数量。

示例

检索所有服务

检索所有服务和依赖的所有相关数据。

请求：

{
           "jsonrpc": "2.0",
           "method": "service.get",
           "params": {
               "output": "extend",
               "selectChildren": "extend",
               "selectParents": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

相应：

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "serviceid": "1",
                   "name": "My Service - 0001",
                   "status": "-1",
                   "algorithm": "2",
                   "sortorder": "0",
                   "weight": "0",
                   "propagation_rule": "0",
                   "propagation_value": "0",
                   "description": "My Service Description 0001.",
                   "uuid": "dfa4daeaea754e3a95c04d6029182681",
                   "created_at": "946684800",
                   "readonly": false,
                   "parents": [],
                   "children": []
               },
               {
                   "serviceid": "2",
                   "name": "My Service - 0002",
                   "status": "-1",
                   "algorithm": "2",
                   "sortorder": "0",
                   "weight": "0",
                   "propagation_rule": "0",
                   "propagation_value": "0",
                   "description": "My Service Description 0002.",
                   "uuid": "20ea0d85212841219130abeaca28c065",
                   "created_at": "946684800",
                   "readonly": false,
                   "parents": [],
                   "children": []
               }
           ],
           "id": 1
       }

来源

CService::get() 在ui/include/classes/api/services/CService.php。