Süre sonu uyarılarını ayarlama

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

TLS geçerlilik süresi uyarısı kullan Bir ortamda TLS sertifikasının süresi dolmak üzereyken bir bildirim

TLS sertifikaları hakkında

TLS (Taşıma Katmanı Güvenliği), standart güvenlik teknolojisidir bir web sunucusu ve bir web istemcisi (ör. tarayıcı veya tarayıcı) arasında şifrelenmiş bağlantı kurmak için uygulamasını indirin. Şifrelenmiş bir bağlantı, sunucu ile istemci arasında iletilen tüm verilerin kalmasını sağlar. özel.

TLS sertifikası, TLS işlemindeki bir varlığı tanımlayan dijital bir dosyadır. Edge, TLS kullanıyor sertifikası alın:

TLS sertifikasının geçerlilik bitiş tarihi vardır. TLS sertifikasının süresi dolarsa TLS bağlantısı başarısız olur sertifika güncelleyene kadar devam eder. Bu, siz sertifikayı güncelleyene kadar API'nize yapılan tüm isteklerin başarısız olacağı anlamına gelir.

Süre sonu uyarıları hakkında

Bir sertifikanın süresinin dolmasını beklemek ve API'nize yapılan isteklerin başarısız olması için süre sonu uyarısı bir ortamdaki herhangi bir TLS sertifikasının süresi dolmak üzereyken bir bildirim Uyarı tetiklendikten sonra, sertifikayı güncelleyerek müşterilerinizin hizmette kesinti olacak.

Uyarıyı yapılandırırken tek bir sertifika değil, belirli bir ortam belirtin. Uyarı, dağıtılan herhangi bir sertifika planlandığında tetiklenir belirtilen zaman aralığında sona erecektir.

Geçerlilik süresi uyarısını şu şekilde ayarlayabilirsiniz:

  • Sertifikaların süresinin dolmasına 1 gün kala
  • Sertifikaların süresinin dolmasına 14 gün kala
  • Sertifikaların süresinin dolmasına 30 gün kala
ziyaret edin. Uyarılar hakkında daha fazla bilgi için Uyarıları ve bildirimleri ayarlama başlıklı makaleye bakın.

Süre sonu uyarıları ve bildirimleri ekleyin

Süre sonu uyarıları ve bildirimleri eklemek için:
  1. Analiz et > Uyarı Kuralları'nı tıklayın.
  2. +Uyarı'yı tıklayın.
  3. Uyarıyla ilgili aşağıdaki genel bilgileri girin:
    Alan Açıklama
    Uyarı adı Uyarının adı. Tetikleyiciyi açıklayan ve sizin için anlamlı olacak bir ad kullanın. Ad 128 karakterden uzun olamaz.
    Açıklama Uyarının açıklaması.
    Uyarı Türü TLS Geçerlilik Bitişi'ni seçin. Görüntüleyin Uyarı türleri hakkında daha fazla bilgi edinin.
    Ortam Açılır listeden ortamı seçin.
    Durum Uyarıyı etkinleştirmek veya devre dışı bırakmak için açma/kapatma düğmesini kullanın.
  4. Uyarıyı tetikleyecek koşul için eşik ve boyutu tanımlayın.
    Koşul Alanı Açıklama
    Eşik

    Süresi dolan sertifikalar için zaman aralığını yapılandırın. Bir sertifikanın süresinin dolacağı zaman:

    • 1 gün
    • 14 gün
    • 30 gün
    Boyut Boyutlar, şuna karşılık gelen Tüm TLS Sertifikaları TLS sertifikasına sahip değildir.
  5. Uyarı bildirimi eklemek için + Bildirim'i tıklayın.
    Bildirim Ayrıntıları Açıklama
    Kanal Kullanmak istediğiniz bildirim kanalını seçin ve hedefi belirtin: E-posta, Slack, PagerDuty veya Webhook.
    Hedef Seçilen kanal türüne göre hedefi belirtin:
    • E-posta - E-posta adresi (ör. joe@company.com)
    • Slack - Slack kanal URL'si (ör. https://hooks.slack.com/services/T00000000/B00000000/XXXXX)
    • PagerDuty - PagerDuty kodu, örneğin abcd1234efgh56789
    • Webhook - Webhook URL'si (ör. https://apigee.com/test-webhook)

      Not: Bildirim başına yalnızca bir hedef belirtebilirsiniz. Birden fazla hedef belirtmek için ek bildirimler ekleyin.
  6. Başka bildirimler eklemek için önceki adımı tekrarlayın.
  7. Bir bildirim eklediyseniz aşağıdaki alanları ayarlayın:
    Alan Açıklama
    Başucu Kitabı (İsteğe bağlı) Sorunu çözmek için önerilen işlemlerin kısa bir açıklamasını sağlayan serbest biçimli metin alanı uyarıları etkinleştirebilirsiniz. Ayrıca, dahili wiki veya topluluk sayfanızın bağlantısını da en iyi uygulamalara başvurmanız. Bu alandaki bilgiler bildirime dahil edilir. Bu alandaki içerikler 1.500 karakterden uzun olamaz.
    Klape Bildirim gönderme sıklığı. Açılır listeden bir değer seçin.
  8. Kaydet'i tıklayın.

Uyarıları Etkinlikler kontrol panelinde görüntüleme

Edge bir uyarı koşulu algıladığında bu koşulu otomatik olarak Edge kullanıcı arayüzündeki Etkinlikler kontrol paneli. Etkinlikler kontrol panelinde gösterilen etkinliklerin listesi hem sabit hem de sertifikalı tüm uyarıları içerir.

Bir uyarıyı görüntülemek için:

  1. Analiz et > Etkinlikler'i tıklayın. Yeni Etkinlikler kontrol paneli görünür:

  2. Etkinlikler kontrol panelini şu ölçütlere göre filtreleyin:

    • Ortam
    • Bölge
    • Dönem
  3. Etkinlik kontrol panelinde, süresi dolacak olan sertifikayı içeren Anahtar Deposu'nu göstermek için bir satır seçin. uyarıyı daha ayrıntılı olarak inceleyin. Anahtar Deposu sayfasından yeni bir sertifika yükleyebilir ve sertifikanın süresi doluyor.

Uyarı API'lerini süre sonu uyarılarıyla birlikte kullanın

Süre sonu uyarılarını oluşturmak ve yönetmek için kullandığınız çoğu API, kullandıklarınızla aynıdır. sabit uyarılarla kontrol edin. Aşağıdaki uyarı API'leri hem sabit hem de süresi dolan uyarılar için aynı şekilde çalışır:

Ancak bazı API'ler, anormallik uyarılarını desteklemek için kullanılan ek özelliklere sahiptir. Örneğin:

  • Uyarıları al: Düzeltilen uyarılar ve anormallik uyarıları dahil olmak üzere tüm uyarıları listeleyin.
  • Uyarı oluştur: Düzeltilmiş veya anormallik uyarısı oluşturun.
  • Uyarı güncelleme: Düzeltilmiş veya anormallik uyarı tanımını güncelleyebilirsiniz.

Süre sonu uyarısı oluştur veya güncelle

Oluşturmak için aynı API'leri kullanın. veya güncelleyin süre sonu uyarısı görebilirsiniz. Oluşturma veya güncelleme için API çağrısının gövdesi süre sonu uyarısı, aşağıdaki değişiklikleri içeren sabit bir uyarı için kullanılanla aynıdır:

  • Uyarının bir süre sonu uyarısı olduğunu belirtmek için aşağıdaki yeni özellikleri eklemeniz gerekir:

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

    Bu özelliklerin varsayılan değerleri şunlardır:

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

  • conditions dizisinde:

    • metrics özelliği yalnızca expiration değerlerini alır.
    • Sertifika geçerlilik süresinin zaman aralığını saniye cinsinden, maksimum 30 gün olacak şekilde belirtmek için gracePeriodSeconds özelliğini kullanın.
    • threshold, durationSeconds ve comparator özellikleri desteklenmez.
  • conditions dizisinin dimensions öğesinde:
    • certificate özelliğinin değerini ANY olarak ayarlamanız gerekir.
    • proxy özelliğinin değerini ALL olarak ayarlamanız gerekir.
    • statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName mülkleri desteklenmez.
  • reportEnabled özelliği, süre sonu uyarıları için desteklenmez.

Aşağıdaki örnek API çağrısı, Üretim ortamının geçerlilik süresi önümüzdeki 30 gün içinde sona erecek. Belirtilen e-posta adresine bir bildirim gönderilir Uyarı tetiklendiğinde:

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
}'

OAuth 2.0 erişim jetonunuz için $ACCESS_TOKEN öğesini şurada açıklandığı şekilde ayarlayın: OAuth 2.0 erişim jetonu alın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma bölümüne bakın.

Süre sonu uyarıları al

Varsayılan olarak Get Alerts API'si sabit ve süresi dolan tüm tanımlı uyarılarla ilgili bilgileri döndürür. Bu API artık sonuçları filtrelemenizi sağlamak için sorgu parametrelerini alır:

  • enabled - true yalnızca etkin uyarıların döndürüleceğini belirtirse. Varsayılan değer false değeridir.
  • alertType - Döndürülecek uyarının türünü belirtir. İzin verilen değerler: runtime, varsayılan ve cert.
  • alertSubType - Döndürülecek uyarı alt türünü belirtir. Varsayılan değer ayarlanmamıştır yani tüm uyarı alt türlerini döndürür. Süre sonu uyarılarını döndürmek için certfixed değerini belirtin.

Örneğin, yalnızca myorg adlı kuruluş için etkinleştirme uyarılarını döndürmek üzere aşağıdaki API çağrısını kullanın:

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

Aşağıdaki çağrı, hem etkin hem de devre dışı olan yalnızca süre sonu uyarılarını döndürür:

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

OAuth 2.0 erişim jetonunuz için $ACCESS_TOKEN öğesini şurada açıklandığı şekilde ayarlayın: OAuth 2.0 erişim jetonu alın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma bölümüne bakın.