Configurare gli avvisi relativi alla scadenza

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Utilizza un avviso di scadenza TLS alert per generare una notifica quando un certificato TLS in un ambiente sta per scadere.

Informazioni sui certificati TLS

TLS (Transport Layer Security) è la tecnologia di sicurezza standard per stabilire un link criptato tra un server web e un client web, come un browser o un' app. Un link criptato garantisce che tutti i dati che passano tra il server e il client rimangano privati.

Un certificato TLS è un file digitale che identifica un'entità in una transazione TLS. Edge utilizza un certificato TLS per configurare TLS per:

Un certificato TLS contiene una data di scadenza. Se un certificato TLS scade, la connessione TLS non riesce finché non aggiorni il certificato. Ciò significa che tutte le richieste alla tua API non andranno a buon fine finché non aggiorni il certificato.

Informazioni sugli avvisi di scadenza

Anziché attendere la scadenza di un certificato e il fallimento delle richieste alla tua API, utilizza un avviso di scadenza per generare una notifica quando un certificato TLS in un ambiente sta per scadere. Una volta attivato l'avviso, puoi aggiornare il certificato in modo che i tuoi clienti non vedano alcuna interruzione del servizio.

Quando configuri l'avviso, non specificare un singolo certificato, ma un ambiente specifico. L'avviso viene attivato quando la scadenza di un certificato di cui è stato eseguito il deployment è prevista entro l'intervallo di tempo specificato.

Puoi impostare l'avviso di scadenza in modo che venga visualizzato:

  • 1 giorno prima della scadenza di un certificato
  • 14 giorni prima della scadenza di un certificato
  • 30 giorni prima della scadenza di un certificato
Per saperne di più sugli avvisi, consulta Configurare avvisi e notifiche.

Aggiungere avvisi e notifiche di scadenza

Per aggiungere avvisi e notifiche di scadenza:
  1. Fai clic su Analizza > Regole di avviso nell'interfaccia utente di Edge.
  2. Fai clic su +Avviso.
  3. Inserisci le seguenti informazioni generali sull'avviso:
    Campo Descrizione
    Nome avviso Nome dell'avviso. Utilizza un nome che descriva il trigger e che sia significativo per te. Il nome non può superare i 128 caratteri.
    Descrizione Descrizione dell'avviso.
    Tipo di avviso: Seleziona Scadenza TLS. Per saperne di più, consulta Informazioni sui tipi di avvisi.
    Ambiente Seleziona l'ambiente dall'elenco a discesa.
    Stato Abilita/disabilita l'avviso.
  4. Definisci la soglia e la dimensione per la condizione che attiverà l'avviso.
    Campo condizione Descrizione
    Soglia

    Configura l'intervallo di tempo per i certificati in scadenza. Puoi scegliere di generare un avviso quando la scadenza di un certificato è prevista tra:

    • 1 giorno
    • 14 giorni
    • 30 giorni
    Dimensione Le dimensioni sono fisse su un valore di Any TLS Certificates (Qualsiasi certificato TLS) corrispondente a qualsiasi certificato TLS nell'ambiente.
  5. Fai clic su + Notifica per aggiungere una notifica di avviso.
    Dettagli notifica Descrizione
    Canale Seleziona il canale di notifica che vuoi utilizzare e specifica la destinazione: email, Slack, PagerDuty o webhook.
    Destinazione Specifica la destinazione in base al tipo di canale selezionato:
    • Email: indirizzo email, ad esempio joe@company.com
    • Slack: URL del canale Slack, ad esempio https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty: codice PagerDuty, ad esempio abcd1234efgh56789
    • Webhook: URL webhook, ad esempio https://apigee.com/test-webhook

      Nota: puoi specificare una sola destinazione per notifica. Per specificare più destinazioni per lo stesso tipo di canale, aggiungi altre notifiche.
  6. Per aggiungere altre notifiche, ripeti il passaggio precedente.
  7. Se hai aggiunto una notifica, imposta i seguenti campi:
    Campo Descrizione
    Playbook (Facoltativo) Campo di testo in formato libero per fornire una breve descrizione delle azioni consigliate per risolvere gli avvisi quando vengono attivati. Puoi anche specificare un link alla pagina wiki o alla pagina della community interna in cui fai riferimento alle best practice. Le informazioni in questo campo verranno incluse nella notifica. I contenuti di questo campo non possono superare i 1500 caratteri.
    Limitazione Frequenza con cui inviare le notifiche. Seleziona un valore dall'elenco a discesa.
  8. Fai clic su Salva.

Visualizzare gli avvisi nella dashboard Eventi

Quando Edge rileva una condizione di avviso, la registra automaticamente nella dashboard Eventi nell'interfaccia utente di Edge. L'elenco degli eventi visualizzato nella dashboard Eventi include tutti gli avvisi, sia quelli fissi sia quelli relativi ai certificati.

Per visualizzare un avviso:

  1. Fai clic su Analizza > Eventi nell'interfaccia utente di Edge. Viene visualizzata la nuova dashboard Eventi:

  2. Filtra la dashboard Eventi per:

    • Ambiente
    • Regione
    • Periodo di tempo
  3. Seleziona una riga nella dashboard Eventi per visualizzare l'archivio chiavi contenente il certificato in scadenza per esaminare ulteriormente l'avviso. Dalla pagina Archivio chiavi, puoi caricare un nuovo certificato ed eliminare quello in scadenza.

Utilizzare le API di avviso con gli avvisi di scadenza

La maggior parte delle API che utilizzi per creare e gestire gli avvisi di scadenza sono le stesse che utilizzi con gli avvisi fissi. Le seguenti API di avviso funzionano allo stesso modo sia per gli avvisi fissi sia per quelli di scadenza:

Tuttavia, alcune API hanno proprietà aggiuntive utilizzate per supportare gli avvisi di anomalia, tra cui:

Creare o aggiornare un avviso di scadenza

Utilizza le stesse API per creare o aggiornare un avviso di scadenza come fai attualmente per un avviso fisso. Il corpo della chiamata API per creare o aggiornare un avviso di scadenza è lo stesso utilizzato per un avviso fisso, con le seguenti modifiche:

  • Devi aggiungere le seguenti nuove proprietà per specificare che l'avviso è un avviso di scadenza:

    "alertType": "cert"
"alertSubType": "certfixed"

    I valori predefiniti di queste proprietà sono:

    "alertType": "runtime"
"alertSubType": "fixed"

  • Nell'array conditions:

    • La proprietà metrics accetta solo i valori di expiration.
    • Utilizza la proprietà gracePeriodSeconds per specificare l'intervallo di tempo della scadenza del certificato in secondi, fino a una durata massima di 30 giorni.
    • Le proprietà threshold, durationSeconds e comparator non sono supportate.
  • Nell'elemento dimensions dell'array conditions:
    • Devi impostare il valore della proprietà certificate su ANY.
    • Devi impostare il valore della proprietà proxy su ALL.
    • Le proprietà statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName non sono supportate.
  • La proprietà reportEnabled non è supportata per gli avvisi di scadenza.

La seguente chiamata API di esempio crea un avviso di scadenza che viene attivato quando la scadenza di un certificato nell'ambiente di produzione è prevista nei prossimi 30 giorni. Quando l'avviso viene attivato, viene inviata una notifica all'indirizzo email specificato:

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
 -X POST \
 -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -d '{
  "organization":"myorg",
  "name":"My Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

Imposta $ACCESS_TOKEN sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni cURL utilizzate in questo esempio, consulta Utilizzare cURL.

Recuperare gli avvisi di scadenza

Per impostazione predefinita, l'API Recupera avvisi restituisce informazioni su tutti gli avvisi definiti, sia quelli fissi sia quelli di scadenza. Questa API ora accetta parametri di query per consentirti di filtrare i risultati:

  • enabled - se true, specifica di restituire solo gli avvisi abilitati. Il valore predefinito è false.
  • alertType - specifica il tipo di avviso da restituire. I valori consentiti sono runtime (valore predefinito) e cert.
  • alertSubType: specifica il sottotipo di avviso da restituire. Il valore predefinito non è impostato, il che significa che vengono restituiti tutti i sottotipi di avviso. Specifica certfixed per restituire gli avvisi di scadenza.

Ad esempio, utilizza la seguente chiamata API per restituire solo gli avvisi abilitati per l'organizzazione denominata myorg:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

La seguente chiamata restituisce solo gli avvisi di scadenza, sia quelli abilitati sia quelli disabilitati:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=cert&alertSubType=certfixed'

Imposta $ACCESS_TOKEN sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni cURL utilizzate in questo esempio, consulta Utilizzare cURL.