sla.get
描述
integer/array sla.get(object parameters)
该方法允许根据给定的参数检索 SLA 对象。
此方法适用于任何类型的用户。权限 调用方法可以在用户角色设置中撤销。请参阅 用户 角色 了解更多信息。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| slaids | 字符串/数组 | 仅返回具有给定 ID 的 SLA。 |
| serviceids | 字符串/数组 | 仅返回与特定服务匹配的 SLA。 |
| selectSchedule | 查询 | 返回带有 SLA 计划的“计划”属性。 支持“计数”。 |
| selectExcludedDowntimes | 查询 | 返回包含 SLA 排除的停机时间的 excluded_downtimes 属性。支持 计数。 |
| selectServiceTags | 查询 | 返回带有 SLA 服务标签的 service_tags 属性。支持 计数。 |
| sortfield | 字符串/数组 | 按给定属性对结果进行排序。 可能的值为： slaid、name、period、slo、effective_date、timezone、status 和 description。 |
| countOutput | 布尔 | 参考注释 中详细描述了所有“get”方法通用的这些参数。 |
| editable | 布尔 | |
| excludeSearch | 布尔 | |
| filter | 对象 | |
| limit | 整数 | |
| output | 查询 | |
| preservekeys | 布尔 | |
| search | 对象 | |
| searchByAny | 布尔 | |
| searchWildcardsEnabled | 布尔 | |
| sortorder | 字符串/数组 | |
| startSearch | 布尔 |
###返回值
(integer/array) 返回以下任一选项
- 对象数组;
- 如果使用
countOutput参数，被检索对象的数量。
示例
检索所有SLAs
检索有关所有 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
},
"auth": "85dd04b94cbfad794616eb923be13c71",
"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() in ui/include/classes/api/services/CSla.php.