sla.get

Descrição

integer/array sla.get(object parameters)

O método permite recuperar objetos SLA de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte Funções do usuário para obter mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método oferece suporte aos parâmetros a seguir.

Parâmetro Tipo Descrição
slaids string/array Retornar apenas SLAs com os IDs fornecidos.
serviceids string/array Retornar apenas SLAs que correspondam aos serviços específicos.
selectSchedule query Retorne uma propriedade schedule com agendamentos de SLA.

Suporta count.
selectExcludedDowntimes query Retorne uma propriedade excluded_downtimes com tempos de inatividade excluídos por SLA.

Suporta count.
selectServiceTags query Retorne uma propriedade service_tags com etiquetas de serviço SLA.

Suporta `count.
sortfield string/array Classifique o resultado pelas propriedades fornecidas.

Os valores possíveis são: slaid, name, period, slo, effective_date, timezone, status e description.
countOutput boolean Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes no comentário de referência.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(integer/array) Retorna:

  • uma matriz de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput foi usado.

Exemplos

Recuperando todos os SLAs

Recupere todos os dados sobre todos os SLAs e suas propriedades.

Request:

{
    "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
}

Response:

{
    "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
}

Fonte

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