Criar Agendamento de Relatório de SLA

curl --request POST \
  --url https://api.altostrat.io/sla/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Resumo Mensal de SLA para Executivos",
  "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": "Regiao",
      "value": "LATAM"
    }
  ],
  "grouping_rules": [
    {
      "key": "Regiao",
      "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": "Resumo Mensal de SLA para Executivos",
  "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": "Regiao",
      "value": "LATAM"
    }
  ],
  "grouping_rules": [
    {
      "key": "Regiao",
      "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"
}

POST

sla

schedules

Criar Agendamento de Relatório de SLA

curl --request POST \
  --url https://api.altostrat.io/sla/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Resumo Mensal de SLA para Executivos",
  "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": "Regiao",
      "value": "LATAM"
    }
  ],
  "grouping_rules": [
    {
      "key": "Regiao",
      "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": "Resumo Mensal de SLA para Executivos",
  "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": "Regiao",
      "value": "LATAM"
    }
  ],
  "grouping_rules": [
    {
      "key": "Regiao",
      "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

Insira seu token de autenticação.

Body

application/json

A configuração do agendamento de relatório de SLA a ser criado.

As propriedades necessárias para criar ou atualizar um agendamento de relatório de SLA.

name

string

required

Um nome legível por humanos para o agendamento do relatório.

Example:

"Resumo Mensal de SLA para Executivos"

sla_target

number

required

A porcentagem da meta de SLA. Sites com tempo de atividade (uptime) abaixo deste valor serão marcados como violados.

Example:

99.95

business_hours_id

string<uuid>

required

O UUID do agendamento de Horário Comercial a ser usado para os cálculos de SLA.

Example:

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

site_selection_mode

enum<string>

required

Determina como os sites são selecionados para o relatório. manual usa o array sites. tags usa seleção dinâmica baseada em site_selection_rules.

Opções disponíveis:

manual,

tags

Example:

"tags"

timezone

string

required

O identificador de fuso horário IANA para agendar o relatório (ex 'America/Sao_Paulo'). Os relatórios são executados às 8h da manhã neste fuso horário.

Example:

"Australia/Sydney"

disabled

boolean

default:false

Se verdadeiro, o agendamento é pausado e não gerará relatórios automaticamente.

daily

boolean

Se verdadeiro, o relatório é executado todos os dias. Apenas um entre daily, weekly ou monthly deve ser verdadeiro.

weekly

boolean

Se verdadeiro, o relatório é executado uma vez por semana no day_of_week especificado.

monthly

boolean

Se verdadeiro, o relatório é executado uma vez por mês no day_of_month especificado.

day_of_week

enum<string>

Obrigatório se weekly for verdadeiro. O dia da semana para executar o relatório.

Opções disponíveis:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

Example:

"monday"

day_of_month

integer

Obrigatório se monthly for verdadeiro. O dia do mês para executar o relatório.

Required range: 1 <= x <= 28

Example:

1

show_only_breached_sites_in_pdf

boolean

default:false

Se verdadeiro, o PDF gerado listará apenas os sites que violaram a meta de SLA.

calculate_sla_within_schedule_hours

boolean

default:true

Se verdadeiro, o SLA é calculado apenas dentro do horário comercial especificado. Se falso, é calculado 24 horas por dia, 7 dias por semana.

site_selection_logic

enum<string>

Quando site_selection_mode é tags, isso determina como múltiplas regras são combinadas. or inclui sites que correspondem a qualquer regra. and inclui sites que correspondem a todas as regras.

Opções disponíveis:

or,

and

Example:

"or"

site_selection_rules

object[]

Uma lista de regras para selecionar dinamicamente sites com base em tags. Obrigatório se site_selection_mode for tags.

Mostrar atributos filhos

grouping_rules

object[]

Uma lista opcional de regras para agrupar sites no relatório por um valor de tag específico (ex: agrupar por 'Regiao').

Mostrar atributos filhos

sites

string<uuid>[]

Uma lista de UUIDs de sites para incluir no relatório. Obrigatório se site_selection_mode for manual.

recipients

string<uuid>[]

Uma lista de UUIDs de destinatários a serem notificados quando o relatório estiver pronto.

ignore_power_outages

boolean

default:false

Se verdadeiro, o tempo de inatividade causado por quedas de energia será excluído dos cálculos de SLA.

notification_group

string | null

O ID de um grupo de notificação para o qual enviar o relatório.

Example:

"network_admins_group"

Response

O agendamento foi criado com sucesso.

A configuração para um relatório de SLA agendado.

string

O identificador exclusivo gerado pelo servidor para o agendamento, prefixado com sla_.

Example:

"sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7"

name

string

Um nome legível por humanos para o agendamento do relatório.

Example:

"Resumo Mensal de SLA para Executivos"

disabled

boolean

default:false

Se verdadeiro, o agendamento é pausado e não gerará relatórios automaticamente.

daily

boolean

Se verdadeiro, o relatório é executado todos os dias. Apenas um entre daily, weekly ou monthly deve ser verdadeiro.

weekly

boolean

Se verdadeiro, o relatório é executado uma vez por semana no day_of_week especificado.

monthly

boolean

Se verdadeiro, o relatório é executado uma vez por mês no day_of_month especificado.

day_of_week

enum<string>

O dia da semana para executar o relatório se weekly for verdadeiro.

Opções disponíveis:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

Example:

"monday"

day_of_month

integer

O dia do mês para executar o relatório se monthly for verdadeiro.

Required range: 1 <= x <= 28

Example:

1

sla_target

number

A porcentagem da meta de SLA. Sites com tempo de atividade (uptime) abaixo deste valor serão marcados como violados.

Example:

99.95

show_only_breached_sites_in_pdf

boolean

default:false

Se verdadeiro, o PDF gerado listará apenas os sites que violaram a meta de SLA.

calculate_sla_within_schedule_hours

boolean

default:true

Se verdadeiro, o SLA é calculado apenas dentro do horário comercial especificado. Se falso, é calculado 24 horas por dia, 7 dias por semana.

business_hours_id

string<uuid>

O UUID do agendamento de Horário Comercial a ser usado para os cálculos de SLA.

Example:

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

site_selection_mode

enum<string>

Determina como os sites são selecionados para o relatório. manual usa o array sites. tags usa seleção dinâmica baseada em site_selection_rules.

Opções disponíveis:

manual,

tags

Example:

"tags"

site_selection_logic

enum<string>

Opções disponíveis:

or,

and

Example:

"or"

site_selection_rules

object[]

Uma lista de regras para selecionar dinamicamente sites com base em tags. Obrigatório se site_selection_mode for tags.

Mostrar atributos filhos

grouping_rules

object[]

Uma lista opcional de regras para agrupar sites no relatório por um valor de tag específico (ex: agrupar por 'Regiao').

Mostrar atributos filhos

sites

string<uuid>[]

Uma lista de UUIDs de sites para incluir no relatório. Obrigatório se site_selection_mode for manual.

recipients

string<uuid>[]

Uma lista de UUIDs de destinatários a serem notificados quando o relatório estiver pronto.

timezone

string

O identificador de fuso horário IANA para agendar o relatório (ex 'America/Sao_Paulo'). Os relatórios são executados às 8h da manhã neste fuso horário.

Example:

"Australia/Sydney"

ignore_power_outages

boolean

default:false

Se verdadeiro, o tempo de inatividade causado por quedas de energia será excluído dos cálculos de SLA.

notification_group

string | null

O ID de um grupo de notificação para o qual enviar o relatório.

Example:

"network_admins_group"

created_at

string<date-time>

O carimbo de data/hora de quando o agendamento foi criado.

updated_at

string<date-time>

O carimbo de data/hora de quando o agendamento foi atualizado pela última vez.

Listar Agendamentos de Relatórios de SLA

Obter um Agendamento de Relatório

⌘I

Começando

Plataforma e Identidade

Gerenciamento e Orquestração de Dispositivos

Automação e IA

Serviços de Rede e Conectividade

Segurança e Gerenciamento de Ameaças

Monitoramento e Análise

Serviços e Utilitários Principais

Criar Agendamento de Relatório de SLA

Authorizations

Body

Response