service.get
描述
integer/array service.get(object parameters)
该方法允许根据给定参数检索服务。
此方法可供任何类型的用户使用。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅User roles。
参数
(object) 定义期望输出的参数。
该方法支持以下参数。
| 参数 | 数据类型 | |
|---|---|---|
| serviceids | string/array | 仅返回具有指定ID的服务。 |
| parentids | string/array | 仅返回链接到指定父服务的服务。 |
| deep_parentids | flag | 返回所有直接和间接子服务。需与parentids一起使用。 |
| childids | string/array | 仅返回链接到指定子服务的服务。 |
| evaltype | integer | 标签搜索规则。 可能值： 0 - (默认) 与/或； 2 - 或。 |
| tags | object/array | 仅返回具有指定标签的服务。根据运算符值对标签值进行精确匹配或大小写敏感/不敏感搜索。 格式： [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]。空array返回所有服务。 可能的运算符值： 0 - (默认) 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。 |
| problem_tags | object/array | 仅返回具有指定问题标签的服务。根据运算符值对标签值进行精确匹配或大小写敏感/不敏感搜索。 格式： [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]。空array返回所有服务。 可能的运算符值： 0 - (默认) 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。 |
| without_problem_tags | flag | 仅返回没有问题标签的服务。 |
| slaids | string/array | 仅返回链接到特定SLA的服务。 |
| selectChildren | query | 返回包含子服务的children属性。支持 count。 |
| selectParents | query | 返回包含父服务的parents属性。支持 count。 |
| selectTags | query | 返回包含服务标签的服务标签属性。 支持 count。 |
| selectProblemEvents | query | 返回包含问题事件objects的array的problem_events属性。问题事件object具有以下属性： eventid - (string) 事件ID；severity - (string) 当前事件严重性；name - (string) 已解决事件名称。支持 count。 |
| selectProblemTags | query | 返回包含问题标签的问题标签属性。 支持 count。 |
| selectStatusRules | query | 返回包含状态规则的状态规则属性。 支持 count。 |
| selectStatusTimeline | object/array | 返回包含指定时间段内服务状态变更的status_timeline属性。格式 [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] - period_from为起始日期（包含；integer时间戳），period_to为结束日期（不包含；integer时间戳）。返回包含 start_value属性和指定时间段内状态变更的服务告警 array的条目array。 |
| sortfield | string/array | 按给定属性排序结果。 可能值： serviceid, name, status, sortorder和created_at。 |
| countOutput | boolean | 这些参数在通用get方法参数中有描述。 |
| 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) 返回以下两种结果之一：
- 一个由objects组成的array；
- 若使用了
countOutput参数，则返回检索到的objects数量。
示例
检索所有服务
获取所有服务及其依赖关系的完整数据。
请求：
{
"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
}来源
位于 ui/include/classes/api/services/CService.php 中的 CService::get() 方法。