获取

描述

integer/array sla.get(object parameters)

该方法允许根据给定的参数检索 SLA 对象。

这个方法所有用户类型都可以是用。在用户角色设置中可以撤销调用该方法的权限。 查看 用户角色 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 按给定属性对结果进行排序。

可能的值:slaidnameperiodsloeffective_datetimezonestatusdescription
countOutput boolean 这些参数在参考说明中进行了描述。
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) 返回条目:

  • 一个数组对象;
  • 如果使用了 countOutput 参数,则返回检索到的对象数量。

示例

检索所有 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": "为主要 SQL 数据库引擎提供出色的正常运行时间。",
            "service_tags": [
                {
                    "tag": "database",
                    "operator": "0",
                    "value": "mysql"
                },
                {
                    "tag": "database",
                    "operator": "0",
                    "value": "postgresql"
                }
            ],
            "schedule": [
                {
                    "period_from": "0",
                    "period_to": "601200"
                }
            ],
            "excluded_downtimes": [
                {
                    "name": "软件版本升级发布",
                    "period_from": "1648760400",
                    "period_to": "1648764900"
                }
            ]
        }
    },
    "id": 1
}

来源

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