service.get
描述
integer/array service.get(object parameters)
此方法允许根据给定的参数检索服务。
此方法允许任何用户使用。可以在用户角色设置中撤销调用此方法的权限。更多信息请查看 用户角色。
参数
(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>"}, ...]。空数组返回所有服务。 可能的运算符值： 0 - (默认) 包含； 1 - 等于； 2 - 不包含； 3 - 不等于； 4 - 存在； 5 - 不存在。 |
| problem_tags | object/array | 仅返回具有给定问题标签的服务。根据运算符值，进行标签的精确匹配或大小写敏感或不敏感的搜索。 格式： [{"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 - (string) 事件ID；severity - (string) 当前事件严重性；name - (string) 已解决事件名称。支持 count。 |
| selectProblemTags | query | 返回带有问题标签的 problem_tags 属性。 支持 count。 |
| selectStatusRules | query | 返回带有状态规则的 status_rules 属性。 支持 count。 |
| selectStatusTimeline | object/array | 返回包含给定期间服务状态变化的 status_timeline 属性。格式 [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] - period_from 是开始日期（包括；整数时间戳），period_to 是结束日期（不包括；整数时间戳），为您感兴趣的期间。返回一个条目数组，每个条目包含一个 start_value 属性和一个 alarms 数组，用于指定期间内的状态变化。 |
| 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 |
返回值
(整型/数组) 返回其中之一：
- 一个对象数组；
- 如果使用
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。