Configurare gli avvisi relativi alla scadenza

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

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

Informazioni sui certificati TLS

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

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

  • Accesso ai proxy API da parte dei client API. Utilizzare host virtuali per configurare TLS.
  • Accesso ai tuoi servizi di backend da parte di Edge. Utilizza endpoint e server di destinazione sul processore di messaggi Edge per configurare TLS.

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 riusciranno finché non aggiorni il certificato.

Informazioni sugli avvisi di scadenza

Piuttosto che attendere la scadenza di un certificato e che le richieste alla tua API non vadano a buon fine, utilizza una avviso di scadenza per aumentare una notifica quando un certificato TLS in un ambiente sta per scadere. Dopo aver attivato l'avviso, potrai aggiornare il certificato in modo che i clienti notare eventuali interruzioni del servizio.

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

Puoi impostare l'avviso di scadenza in modo che si verifichi:

  • 1 giorno prima della scadenza di qualsiasi certificato
  • 14 giorni prima della scadenza di qualsiasi certificato
  • 30 giorni prima della scadenza di qualsiasi certificato
di Gemini Advanced. Per saperne di più sugli avvisi, vedi Configurare avvisi e notifiche.

Aggiungere avvisi di scadenza e notifiche

Per aggiungere avvisi e notifiche di scadenza:
  1. Fai clic su Analizza > Regole di avviso nella UI 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 l'attivatore e che sia significativo per te. Il nome non può contenere più di 128 caratteri.
    Descrizione Descrizione dell'avviso.
    Tipo di avviso: Seleziona Scadenza TLS. Consulta Per saperne di più, consulta Informazioni sui tipi di avvisi.
    Ambiente Seleziona l'ambiente dall'elenco a discesa.
    Stato Attiva/disattiva l'avviso per abilitare o disabilitare 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 un certificato sta per scadere:

    • 1 giorno
    • 14 giorni
    • 30 giorni
    Dimensione Le dimensioni sono fisse sul valore 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 il problema gli avvisi quando vengono attivati. Puoi anche specificare un link alla tua pagina wiki interna o community in cui fai riferimento alle best practice. Le informazioni in questo campo verranno incluse nella notifica. Il contenuto di questo campo non può superare i 1500 caratteri.
    Limitazione Frequenza di invio delle notifiche. Seleziona un valore dall'elenco a discesa.
  8. Fai clic su Salva.

Visualizza gli avvisi nella dashboard Eventi

Quando Edge rileva una condizione di avviso, la registra automaticamente nel Dashboard Eventi nella UI Edge. L'elenco di eventi visualizzati nella dashboard Eventi include tutti gli avvisi, sia fissi che di certificazione.

Per visualizzare un avviso:

  1. Fai clic su Analizza > Eventi nell'UI 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 indagare ulteriormente sull'avviso. Dalla pagina Archivio chiavi puoi caricare un nuovo certificato ed eliminare certificato in scadenza.

Utilizza 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 con avvisi corretti. Le seguenti API di avviso funzionano allo stesso modo sia per gli avvisi fissi che per quelli relativi alla scadenza:

Tuttavia, alcune API dispongono di proprietà aggiuntive utilizzate per supportare gli avvisi relativi alle anomalie, tra cui:

Creare o aggiornare un avviso di scadenza

Utilizza le stesse API per creare o aggiorna 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 nuove proprietà seguenti per specificare che l'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 in secondi della scadenza del certificato, 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.
    • statusCode, developerApp, collection, faultCodeCategory, Le proprietà faultCodeSubCategory, faultCodeName non sono supportate.
  • La proprietà reportEnabled non è supportata per gli avvisi di scadenza.

La chiamata API di esempio seguente crea un avviso di scadenza che viene attivato quando viene eseguito un errore nella di produzione scadrà nei prossimi 30 giorni. Viene inviata una notifica all'indirizzo email specificato Quando l'avviso viene attivato:

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 tuo token di accesso OAuth 2.0, come descritto in Ottieni un token di accesso OAuth 2.0. Per informazioni sulle opzioni cURL utilizzate in questo esempio, consulta Utilizzare cURL.

Ricevi avvisi di scadenza

Per impostazione predefinita, l'API Get Alerts restituisce informazioni su tutti gli avvisi definiti, sia fissi che con scadenza. Questa API ora utilizza i parametri di query per consentirti di filtrare i risultati:

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

Ad esempio, utilizza la seguente chiamata API per attivare solo gli avvisi 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 avvisi di scadenza, sia abilitati che disabilitati:

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

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