sla.get

Описание

integer/array sla.get(параметры объекта)

Метод позволяет получать объекты SLA по заданным параметрам.

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object) Параметры, определяющие желаемый вывод.

Метод поддерживает следующие параметры.

Параметр Тип Описание
slaids ID/array Возвращать только SLA с указанными ID.
serviceids ID/array Возвращать только SLA, соответствующие указанным сервисам.
selectSchedule query Возвращать свойство schedule с расписаниями SLA.

Поддерживает count.
selectExcludedDowntimes query Возвращать свойство excluded_downtimes с исключенными простоями SLA.

Поддерживает count.
selectServiceTags query Возвращать свойство service_tags с тегами сервисов SLA.

Поддерживает count.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: slaid, name, period, slo, effective_date, timezone, status, description.
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.