Documentation
sla.get
描述
integer/array sla.get(object parameters)
该方法允许根据给定的参数检索 SLA objects。
此方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。更多信息请参见 User roles。
参数
(object) 用于定义期望输出的参数。
该方法支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| slaids | ID/array | 仅返回具有给定ID的SLA。 |
| serviceids | ID/array | 仅返回匹配特定服务的SLA。 |
| selectSchedule | query | 返回带有SLA计划的 schedule 属性。支持 count。 |
| selectExcludedDowntimes | query | 返回带有SLA排除停机时间的 excluded_downtimes 属性。支持 count。 |
| selectServiceTags | query | 返回带有SLA服务标签的 service_tags 属性。支持 count。 |
| sortfield | string/array | 按照给定属性对结果进行排序。 可能的值: slaid, name, period, slo, effective_date, timezone, status, description。 |
| 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) 返回以下之一：
- array 的 objects；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
检索所有SLA
检索所有SLA及其属性的所有数据。
执行请求:
{
"jsonrpc": "2.0",
"method": "sla.get",
"params": {
"output": "extend",
"selectSchedule": ["period_from", "period_to"],
"selectExcludedDowntimes": ["name", "period_from", "period_to"],
"selectServiceTags": ["tag", "operator", "value"],
"preservekeys": true
},
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": {
"1": {
"slaid": "1",
"name": "Database Uptime",
"period": "1",
"slo": "99.9995",
"effective_date": "1672444800",
"timezone": "America/Toronto",
"status": "1",
"description": "Provide excellent uptime for main SQL database engines.",
"service_tags": [
{
"tag": "database",
"operator": "0",
"value": "mysql"
},
{
"tag": "database",
"operator": "0",
"value": "postgresql"
}
],
"schedule": [
{
"period_from": "0",
"period_to": "601200"
}
],
"excluded_downtimes": [
{
"name": "Software version upgrade rollout",
"period_from": "1648760400",
"period_to": "1648764900"
}
]
}
},
"id": 1
}来源
CSla:get() 在 ui/include/classes/api/services/CSla.php 中。