API per avvisare i punti di contatto

Nella versione 13 di Grafana, le notifiche vengono gestite tramite gli avvisi unificati di Grafana. L'API dei canali di notifica legacy (gli /api/alert-notifications endpoint) è stata rimossa insieme agli avvisi precedenti nella versione 11 di Grafana e non è più disponibile. Utilizza invece l'API di provisioning degli avvisi per lavorare con i punti di contatto, che sostituiscono gli avvisi unificati ai canali di notifica.

Nota

Per utilizzare un'API Grafana con il tuo spazio di lavoro Amazon Managed Grafana, devi disporre di un token di account di servizio valido. Lo includi nel Authorization campo della richiesta API.

Nota

Gli endpoint dei punti di contatto per la fornitura di avvisi che elencano, creano, aggiornano o eliminano i punti di contatto (GET, POSTPUT, e così DELETE via/api/v1/provisioning/contact-points) sono obsoleti. Le risposte provenienti da questi endpoint includono un'intestazione e un'Warningintestazione con la data di. X-API-Deprecation-Date 2026-04-07 Questo argomento documenta per intero gli endpoint che non sono obsoleti GET /api/alert-notifiers ed elenca gli endpoint GET /api/v1/provisioning/contact-points/export obsoleti solo come riferimento.

Elenca i tipi di punti di contatto

Restituisce l'elenco dei tipi di punti di contatto (notificatori) disponibili nel tuo spazio di lavoro Amazon Managed Grafana. Usa questo endpoint per scoprire quali tipi di punti di contatto puoi configurare e le opzioni supportate da ciascun tipo.

GET /api/alert-notifiers

Parametri di query

• version— (Facoltativo) Impostato per 2 restituire lo schema completo del tipo di integrazione per ogni tipo di punto di contatto. Se omesso, l'endpoint restituisce l'elenco predefinito dei tipi di punti di contatto.

Richiesta di esempio

GET /api/alert-notifiers HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1234abcd567exampleToken890

Risposta

La risposta è un array JSON in cui ogni elemento descrive un tipo di punto di contatto disponibile. Ogni elemento include l'identificatore di tipo (type), il display namedescription, a e la configurazione options supportata dal tipo.

Esporta i punti di contatto

Restituisce i punti di contatto definiti nell'area di lavoro Amazon Managed Grafana in un formato che puoi usare per fornire gli avvisi sotto forma di codice. Questo endpoint non è obsoleto.

GET /api/v1/provisioning/contact-points/export

Parametri di query

• name— (Facoltativo) Filtra i punti di contatto esportati in base al nome del punto di contatto.

• decrypt— (Facoltativo) Se decrittografare e includere impostazioni sicure nell'esportazione. L’impostazione predefinita è false.

• format— (Facoltativo) Il formato di output per l'esportazione, ad esempio jsonyaml, o hcl (Terraform).

Richiesta di esempio

GET /api/v1/provisioning/contact-points/export?format=yaml HTTP/1.1
Accept: application/json
Authorization: Bearer 1234abcd567exampleToken890

Risposta

Restituisce i punti di contatto nel formato richiesto, adatto per l'uso con file provisioning o Terraform. Per impostazione predefinita, le impostazioni sicure vengono oscurate a meno che non lo si imposti. decrypt true

Endpoint dei punti di contatto obsoleti

I seguenti endpoint di attivazione degli avvisi gestiscono i punti di contatto ma sono obsoleti. Le risposte includono un'intestazione e un'Warningintestazione con la data di. X-API-Deprecation-Date 2026-04-07 Sono elencati qui solo come riferimento e potrebbero essere rimossi in una versione futura.

• GET /api/v1/provisioning/contact-points— Restituisce tutti i punti di contatto. Accetta un parametro di name interrogazione opzionale per filtrare in base al nome del punto di contatto.

• POST /api/v1/provisioning/contact-points— Crea un punto di contatto.

• PUT /api/v1/provisioning/contact-points/{UID}— Aggiorna il punto di contatto con quello specificatoUID.

• DELETE /api/v1/provisioning/contact-points/{UID}— Elimina il punto di contatto con quello specificatoUID.

L'oggetto punto di contatto utilizzato da questi endpoint include i seguenti campi.

• uid— (Facoltativo) Un identificatore univoco definito dall'utente per il punto di contatto.

• name— (Obbligatorio) Il nome del punto di contatto. I punti di contatto che condividono un nome sono raggruppati.

• type— (Obbligatorio) Il tipo di punto di contatto, ad esempio emailslack, owebhook.

• settings— (Obbligatorio) Un oggetto specifico del tipo che contiene la configurazione del punto di contatto.

• disableResolveMessage— (Facoltativo) Se sopprimere la notifica inviata quando si risolve un avviso.

• provenance— (Read-only) Indica come è stato fornito il punto di contatto.