/ /

Medições e alertas

Configurações de alerta global

Página inicial do Docs

Configurações de alerta global

Teste a Configuração de Alerta Global

Aciona uma notificação de teste para um método de notificação específico em uma configuração de alerta global. Esse endpoint envia uma carga de teste com dados fictícios e modelos renderizados para validar sua configuração de webhook.

Solicitar

POST /api/public/v1.0/globalAlertConfigs/{ALERT-CONFIG-ID}/{NOTIFICATION-ID}/test

Parâmetros do caminho da solicitação

Parâmetro	Tipo	Descrição
alerta-CONFIG-ID	string	String única de 24dígitos hexadecimais que identifica a configuração de alerta global.
ID de notificação	string	String exclusiva de 24dígitos hexadecimais que identifica o método de notificação na configuração de alerta global.

Solicitar parâmetros de query

Este endpoint não usa parâmetros de query de solicitação HTTP.

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Elementos de resposta

Se você definir o parâmetro de query pretty=true, a resposta será exibida em um formato legível.

Parâmetro	Tipo	Descrição
Sucesso	booleano	Sinalizador que indica se a notificação de teste foi enviada com sucesso.
mensagem	string	Mensagem legível por humanos descrevendo o resultado da operação de teste.
Detalhes	objeto	Detalhes adicionais sobre a notificação de teste.
Details.notificationType	string	Tipo de notificação que foi testado (por exemplo, `WEBHOOK`, `EMAIL`).
Details.destination	string	Destino para onde a notificação de teste foi enviada. Para webhooks, esta é a URL do webhook .
Details.timestamp	string	Carimbo de data/hora ISO 8601 em que a notificação do teste foi enviada.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://ops-manager.example.com:8080/api/public/v1.0/globalAlertConfigs/{ALERT-CONFIG-ID}/{NOTIFICATION-ID}/test?pretty=true"

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Corpo de resposta

{
  "success": true,
  "message": "Test notification sent successfully",
  "details": {
    "notificationType": "WEBHOOK",
    "destination": "https://example.com/webhook",
    "timestamp": "2025-01-15T10:30:00Z"
  }
}

Voltar

Excluir

Eventos globais