Actualizar una Programación de Informe

curl --request PUT \
  --url https://api.altostrat.io/sla/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Resumen Ejecutivo Mensual de SLA",
  "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": "Región",
      "value": "APAC"
    }
  ],
  "grouping_rules": [
    {
      "key": "Región",
      "aggregation": "avg"
    }
  ],
  "sites": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "recipients": [
    "e47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "timezone": "Australia/Sydney",
  "ignore_power_outages": false,
  "notification_group": "grupo_admins_red"
}'

{
  "id": "sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7",
  "name": "Resumen Ejecutivo Mensual de SLA",
  "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": "Región",
      "value": "APAC"
    }
  ],
  "grouping_rules": [
    {
      "key": "Región",
      "aggregation": "avg"
    }
  ],
  "sites": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "recipients": [
    "e47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "timezone": "Australia/Sydney",
  "ignore_power_outages": false,
  "notification_group": "grupo_admins_red",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

PUT

sla

schedules

{scheduleId}

Actualizar una Programación de Informe

curl --request PUT \
  --url https://api.altostrat.io/sla/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Resumen Ejecutivo Mensual de SLA",
  "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": "Región",
      "value": "APAC"
    }
  ],
  "grouping_rules": [
    {
      "key": "Región",
      "aggregation": "avg"
    }
  ],
  "sites": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "recipients": [
    "e47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "timezone": "Australia/Sydney",
  "ignore_power_outages": false,
  "notification_group": "grupo_admins_red"
}'

{
  "id": "sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7",
  "name": "Resumen Ejecutivo Mensual de SLA",
  "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": "Región",
      "value": "APAC"
    }
  ],
  "grouping_rules": [
    {
      "key": "Región",
      "aggregation": "avg"
    }
  ],
  "sites": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "recipients": [
    "e47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "timezone": "Australia/Sydney",
  "ignore_power_outages": false,
  "notification_group": "grupo_admins_red",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Introduzca su token de autenticación.

Path Parameters

scheduleId

string

required

El identificador único para la programación de informe SLA a actualizar, con el prefijo sla_.

Example:

"sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7"

Body

application/json

La configuración actualizada de la programación de informe SLA.

Las propiedades requeridas para crear o actualizar una programación de informe SLA.

name

string

required

Un nombre legible por humanos para la programación del informe.

Example:

"Resumen Ejecutivo Mensual de SLA"

sla_target

number

required

El porcentaje objetivo de SLA. Los sitios con un tiempo de actividad por debajo de este valor se marcarán como incumplidos.

Example:

99.95

business_hours_id

string<uuid>

required

El UUID de la programación de Horario Comercial a utilizar para los cálculos de SLA.

Example:

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

site_selection_mode

enum<string>

required

Determina cómo se seleccionan los sitios para el informe. manual utiliza el array sites. tags utiliza la selección dinámica basada en site_selection_rules.

Opciones disponibles:

manual,

tags

Example:

"tags"

timezone

string

required

El identificador de zona horaria IANA para programar el informe (p. ej., 'America/New_York'). Los informes se ejecutan a las 8 AM en esta zona horaria.

Example:

"Australia/Sydney"

notification_group

string

required

El ID de un grupo de notificación al que enviar el informe.

Example:

"grupo_admins_red"

disabled

boolean

default:false

Si es verdadero, la programación se pausa y no generará informes automáticamente.

daily

boolean

Si es verdadero, el informe se ejecuta todos los días. Solo uno de daily, weekly o monthly debe ser verdadero.

weekly

boolean

Si es verdadero, el informe se ejecuta una vez a la semana en el day_of_week especificado.

monthly

boolean

Si es verdadero, el informe se ejecuta una vez al mes en el day_of_month especificado.

day_of_week

enum<string>

Requerido si weekly es verdadero. El día de la semana para ejecutar el informe.

Opciones disponibles:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

Example:

"monday"

day_of_month

integer

Requerido si monthly es verdadero. El día del mes para ejecutar el informe.

Required range: 1 <= x <= 28

Example:

1

show_only_breached_sites_in_pdf

boolean

default:false

Si es verdadero, el PDF generado solo listará los sitios que incumplieron el objetivo de SLA.

calculate_sla_within_schedule_hours

boolean

default:true

Si es verdadero, el SLA se calcula solo dentro del horario comercial especificado. Si es falso, se calcula 24/7.

site_selection_logic

enum<string>

Cuando site_selection_mode es tags, esto determina cómo se combinan múltiples reglas. or incluye sitios que coinciden con cualquier regla. and incluye sitios que coinciden con todas las reglas.

Opciones disponibles:

or,

and

Example:

"or"

site_selection_rules

object[]

Una lista de reglas para seleccionar sitios dinámicamente según las etiquetas. Requerido si site_selection_mode es tags.

Mostrar atributos secundarios

grouping_rules

object[]

Una lista opcional de reglas para agrupar sitios en el informe por un valor de etiqueta específico (por ejemplo, agrupar por 'Región').

Mostrar atributos secundarios

sites

string<uuid>[]

Una lista de UUIDs de sitios para incluir en el informe. Requerido si site_selection_mode es manual.

recipients

string<uuid>[]

Una lista de UUIDs de destinatarios a notificar cuando el informe esté listo.

ignore_power_outages

boolean

default:false

Si es verdadero, el tiempo de inactividad causado por cortes de energía se excluirá de los cálculos de SLA.

Response

La programación se actualizó correctamente.

La configuración para un informe SLA programado.

string

El identificador único generado por el servidor para la programación, con el prefijo sla_.

Example:

"sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7"

name

string

Un nombre legible por humanos para la programación del informe.

Example:

"Resumen Ejecutivo Mensual de SLA"

disabled

boolean

default:false

Si es verdadero, la programación se pausa y no generará informes automáticamente.

daily

boolean

Si es verdadero, el informe se ejecuta todos los días. Solo uno de daily, weekly o monthly debe ser verdadero.

weekly

boolean

Si es verdadero, el informe se ejecuta una vez a la semana en el day_of_week especificado.

monthly

boolean

Si es verdadero, el informe se ejecuta una vez al mes en el day_of_month especificado.

day_of_week

enum<string>

El día de la semana para ejecutar el informe si weekly es verdadero.

Opciones disponibles:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

Example:

"monday"

day_of_month

integer

El día del mes para ejecutar el informe si monthly es verdadero.

Required range: 1 <= x <= 28

Example:

1

sla_target

number

El porcentaje objetivo de SLA. Los sitios con un tiempo de actividad por debajo de este valor se marcarán como incumplidos.

Example:

99.95

show_only_breached_sites_in_pdf

boolean

default:false

Si es verdadero, el PDF generado solo listará los sitios que incumplieron el objetivo de SLA.

calculate_sla_within_schedule_hours

boolean

default:true

Si es verdadero, el SLA se calcula solo dentro del horario comercial especificado. Si es falso, se calcula 24/7.

business_hours_id

string<uuid>

El UUID de la programación de Horario Comercial a utilizar para los cálculos de SLA.

Example:

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

site_selection_mode

enum<string>

Determina cómo se seleccionan los sitios para el informe. manual utiliza el array sites. tags utiliza la selección dinámica basada en site_selection_rules.

Opciones disponibles:

manual,

tags

Example:

"tags"

site_selection_logic

enum<string>

Opciones disponibles:

or,

and

Example:

"or"

site_selection_rules

object[]

Una lista de reglas para seleccionar sitios dinámicamente según las etiquetas. Requerido si site_selection_mode es tags.

Mostrar atributos secundarios

grouping_rules

object[]

Una lista opcional de reglas para agrupar sitios en el informe por un valor de etiqueta específico (por ejemplo, agrupar por 'Región').

Mostrar atributos secundarios

sites

string<uuid>[]

Una lista de UUIDs de sitios para incluir en el informe. Requerido si site_selection_mode es manual.

recipients

string<uuid>[]

Una lista de UUIDs de destinatarios a notificar cuando el informe esté listo.

timezone

string

El identificador de zona horaria IANA para programar el informe (p. ej., 'America/New_York'). Los informes se ejecutan a las 8 AM en esta zona horaria.

Example:

"Australia/Sydney"

ignore_power_outages

boolean

default:false

Si es verdadero, el tiempo de inactividad causado por cortes de energía se excluirá de los cálculos de SLA.

notification_group

string | null

El ID de un grupo de notificación al que enviar el informe.

Example:

"grupo_admins_red"

created_at

string<date-time>

La marca de tiempo de cuándo se creó la programación.

updated_at

string<date-time>

La marca de tiempo de la última actualización de la programación.

Obtener una Programación de Informe

Eliminar una Programación de Informe

⌘I

Empezando

Plataforma e Identidad

Gestión y Orquestación de Dispositivos

Automatización e IA

Servicios de Red y Conectividad

Seguridad y Gestión de Amenazas

Monitorización y Análisis

Servicios y Utilidades Principales

Actualizar una Programación de Informe

Authorizations

Path Parameters

Body

Response