Vai al contenuto principale
PUT
/
sla
/
schedules
/
{scheduleId}
Aggiorna una Pianificazione di Report
curl --request PUT \
  --url https://api.altostrat.io/sla/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Riepilogo SLA Mensile Direzionale",
  "disabled": false,
  "daily": true,
  "weekly": true,
  "monthly": true,
  "day_of_week": "monday",
  "day_of_month": 1,
  "sla_target": 99.95,
  "show_only_breached_sites_in_pdf": false,
  "calculate_sla_within_schedule_hours": true,
  "business_hours_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "site_selection_mode": "tags",
  "site_selection_logic": "or",
  "site_selection_rules": [
    {
      "key": "Region",
      "value": "APAC"
    }
  ],
  "grouping_rules": [
    {
      "key": "Region",
      "aggregation": "avg"
    }
  ],
  "sites": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "recipients": [
    "e47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "timezone": "Australia/Sydney",
  "ignore_power_outages": false,
  "notification_group": "network_admins_group"
}'
{
  "id": "sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7",
  "name": "Riepilogo SLA Mensile Direzionale",
  "disabled": false,
  "daily": true,
  "weekly": true,
  "monthly": true,
  "day_of_week": "monday",
  "day_of_month": 1,
  "sla_target": 99.95,
  "show_only_breached_sites_in_pdf": false,
  "calculate_sla_within_schedule_hours": true,
  "business_hours_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "site_selection_mode": "tags",
  "site_selection_logic": "or",
  "site_selection_rules": [
    {
      "key": "Region",
      "value": "APAC"
    }
  ],
  "grouping_rules": [
    {
      "key": "Region",
      "aggregation": "avg"
    }
  ],
  "sites": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "recipients": [
    "e47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "timezone": "Australia/Sydney",
  "ignore_power_outages": false,
  "notification_group": "network_admins_group",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Inserisci il tuo token di autenticazione.

Path Parameters

scheduleId
string
required

L'identificatore univoco per la pianificazione del report SLA da aggiornare, con prefisso sla_.

Example:

"sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7"

Body

application/json

La configurazione aggiornata della pianificazione del report SLA.

Le proprietà richieste per creare o aggiornare una pianificazione di report SLA.

name
string
required

Un nome leggibile per la pianificazione del report.

Example:

"Riepilogo SLA Mensile Direzionale"

sla_target
number
required

La percentuale SLA target. I siti con un uptime inferiore a questo valore saranno contrassegnati come non conformi.

Example:

99.95

business_hours_id
string<uuid>
required

L'UUID della pianificazione dell'Orario di Lavoro da utilizzare per i calcoli dello SLA.

Example:

"a1b2c3d4-e5f6-7890-1234-567890abcdef"

site_selection_mode
enum<string>
required

Determina come vengono selezionati i siti per il report. manual utilizza l'array sites. tags utilizza una selezione dinamica basata su site_selection_rules.

Opzioni disponibili:
manual,
tags
Example:

"tags"

timezone
string
required

L'identificatore di fuso orario IANA per la pianificazione del report (es. 'America/New_York'). I report vengono eseguiti alle 8:00 in questo fuso orario.

Example:

"Australia/Sydney"

notification_group
string
required

L'ID di un gruppo di notifica a cui inviare il report.

Example:

"network_admins_group"

disabled
boolean
default:false

Se true, la pianificazione è in pausa e non genererà report automaticamente.

daily
boolean

Se true, il report viene eseguito ogni giorno. Solo una tra daily, weekly o monthly deve essere true.

weekly
boolean

Se true, il report viene eseguito una volta a settimana nel day_of_week specificato.

monthly
boolean

Se true, il report viene eseguito una volta al mese nel day_of_month specificato.

day_of_week
enum<string>

Richiesto se weekly è true. Il giorno della settimana in cui eseguire il report.

Opzioni disponibili:
monday,
tuesday,
wednesday,
thursday,
friday,
saturday,
sunday
Example:

"monday"

day_of_month
integer

Richiesto se monthly è true. Il giorno del mese in cui eseguire il report.

Required range: 1 <= x <= 28
Example:

1

show_only_breached_sites_in_pdf
boolean
default:false

Se true, il PDF generato elencherà solo i siti che non hanno rispettato il target SLA.

calculate_sla_within_schedule_hours
boolean
default:true

Se true, lo SLA viene calcolato solo durante l'orario di lavoro specificato. Se false, viene calcolato 24/7.

site_selection_logic
enum<string>

Quando site_selection_mode è tags, questo determina come vengono combinate più regole. or include i siti che corrispondono a qualsiasi regola. and include i siti che corrispondono a tutte le regole.

Opzioni disponibili:
or,
and
Example:

"or"

site_selection_rules
object[]

Un elenco di regole per selezionare dinamicamente i siti in base ai tag. Richiesto se site_selection_mode è tags.

grouping_rules
object[]

Un elenco opzionale di regole per raggruppare i siti nel report in base a un valore di tag specifico (es. raggruppa per 'Regione').

sites
string<uuid>[]

Un elenco di UUID di siti da includere nel report. Richiesto se site_selection_mode è manual.

recipients
string<uuid>[]

Un elenco di UUID di destinatari da notificare quando il report è pronto.

ignore_power_outages
boolean
default:false

Se true, i tempi di inattività causati da interruzioni di corrente saranno esclusi dai calcoli dello SLA.

Response

La pianificazione è stata aggiornata con successo.

La configurazione per un report SLA pianificato.

id
string

L'identificatore univoco generato dal server per la pianificazione, con prefisso sla_.

Example:

"sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7"

name
string

Un nome leggibile per la pianificazione del report.

Example:

"Riepilogo SLA Mensile Direzionale"

disabled
boolean
default:false

Se true, la pianificazione è in pausa e non genererà report automaticamente.

daily
boolean

Se true, il report viene eseguito ogni giorno. Solo una tra daily, weekly o monthly deve essere true.

weekly
boolean

Se true, il report viene eseguito una volta a settimana nel day_of_week specificato.

monthly
boolean

Se true, il report viene eseguito una volta al mese nel day_of_month specificato.

day_of_week
enum<string>

Il giorno della settimana in cui eseguire il report se weekly è true.

Opzioni disponibili:
monday,
tuesday,
wednesday,
thursday,
friday,
saturday,
sunday
Example:

"monday"

day_of_month
integer

Il giorno del mese in cui eseguire il report se monthly è true.

Required range: 1 <= x <= 28
Example:

1

sla_target
number

La percentuale SLA target. I siti con un uptime inferiore a questo valore saranno contrassegnati come non conformi.

Example:

99.95

show_only_breached_sites_in_pdf
boolean
default:false

Se true, il PDF generato elencherà solo i siti che non hanno rispettato il target SLA.

calculate_sla_within_schedule_hours
boolean
default:true

Se true, lo SLA viene calcolato solo durante l'orario di lavoro specificato. Se false, viene calcolato 24/7.

business_hours_id
string<uuid>

L'UUID della pianificazione dell'Orario di Lavoro da utilizzare per i calcoli dello SLA.

Example:

"a1b2c3d4-e5f6-7890-1234-567890abcdef"

site_selection_mode
enum<string>

Determina come vengono selezionati i siti per il report. manual utilizza l'array sites. tags utilizza una selezione dinamica basata su site_selection_rules.

Opzioni disponibili:
manual,
tags
Example:

"tags"

site_selection_logic
enum<string>

Quando site_selection_mode è tags, questo determina come vengono combinate più regole. or include i siti che corrispondono a qualsiasi regola. and include i siti che corrispondono a tutte le regole.

Opzioni disponibili:
or,
and
Example:

"or"

site_selection_rules
object[]

Un elenco di regole per selezionare dinamicamente i siti in base ai tag. Richiesto se site_selection_mode è tags.

grouping_rules
object[]

Un elenco opzionale di regole per raggruppare i siti nel report in base a un valore di tag specifico (es. raggruppa per 'Regione').

sites
string<uuid>[]

Un elenco di UUID di siti da includere nel report. Richiesto se site_selection_mode è manual.

recipients
string<uuid>[]

Un elenco di UUID di destinatari da notificare quando il report è pronto.

timezone
string

L'identificatore di fuso orario IANA per la pianificazione del report (es. 'America/New_York'). I report vengono eseguiti alle 8:00 in questo fuso orario.

Example:

"Australia/Sydney"

ignore_power_outages
boolean
default:false

Se true, i tempi di inattività causati da interruzioni di corrente saranno esclusi dai calcoli dello SLA.

notification_group
string | null

L'ID di un gruppo di notifica a cui inviare il report.

Example:

"network_admins_group"

created_at
string<date-time>

La data e ora di creazione della pianificazione.

updated_at
string<date-time>

La data e ora dell'ultimo aggiornamento della pianificazione.