Süre sonu uyarılarını ayarlama

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Bir ortamdaki TLS sertifikasının geçerlilik süresi dolmak üzereyken bildirim göndermek için TLS geçerlilik süresi uyarısı kullanın.

TLS sertifikaları hakkında

TLS (Taşıma Katmanı Güvenliği), bir web sunucusu ile tarayıcı veya uygulama gibi bir web istemcisi arasında şifrelenmiş bir bağlantı oluşturmak için kullanılan standart güvenlik teknolojisidir. Şifrelenmiş bir bağlantı, sunucu ile istemci arasında geçen tüm verilerin gizli kalmasını sağlar.

TLS sertifikası, TLS işlemindeki bir varlığı tanımlayan dijital bir dosyadır. Edge, TLS'yi yapılandırmak için TLS sertifikası kullanır:

TLS sertifikasının geçerlilik bitiş tarihi vardır. TLS sertifikasının süresi dolarsa sertifikayı güncelleyene kadar TLS bağlantısı başarısız olur. Bu durumda, sertifikayı güncelleyene kadar API'nize yapılan tüm istekler başarısız olur.

Son kullanma tarihi uyarıları hakkında

Sertifikanın süresinin dolmasını ve API'nize yapılan isteklerin başarısız olmasını beklemek yerine, bir ortamdaki TLS sertifikalarının süresi dolmak üzere olduğunda bildirim göndermek için süre bitimi uyarısı kullanın. Uyarı tetiklendikten sonra, müşterilerinizin hizmette kesinti yaşamaması için sertifikayı güncelleyebilirsiniz.

Uyarıyı yapılandırırken belirli bir sertifika değil, belirli bir ortam belirtin. Uyarı, dağıtılan sertifikalardan herhangi birinin belirtilen zaman aralığında süresinin dolması planlandığında tetiklenir.

Son kullanma tarihi uyarısını şu şekilde ayarlayabilirsiniz:

  • Sertifikaların geçerlilik süresi bitmeden 1 gün önce
  • Sertifikaların geçerlilik süresi dolmadan 14 gün önce
  • Sertifikaların geçerlilik süresi bitmeden 30 gün önce
Uyarılar hakkında daha fazla bilgi için Uyarıları ve bildirimleri ayarlama başlıklı makaleyi inceleyin.

Son kullanma tarihi uyarıları ve bildirimleri ekleme

Son kullanma tarihi uyarıları ve bildirimleri eklemek için:
  1. Edge kullanıcı arayüzünde Analyze > Alert Rules'u (Analiz > Uyarı Kuralları) tıklayın.
  2. +Uyarı'yı tıklayın.
  3. Uyarı hakkında 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 karakteri aşamaz.
    Açıklama Uyarının açıklaması.
    Uyarı Türü TLS Expiry'yi (TLS Geçerlilik Bitiş Tarihi) seçin. Daha fazla bilgi için Uyarı türleri hakkında başlıklı makaleyi inceleyin.
    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 tıklayın.
  4. Uyarıyı tetikleyecek koşulun eşiğini ve boyutunu tanımlayın.
    Koşul Alanı Açıklama
    Eşik

    Süresi dolan sertifikalar için zaman aralığını yapılandırın. Aşağıdaki süreler içinde sona erecek sertifikalar için uyarı oluşturmayı seçebilirsiniz:

    • 1 gün
    • 14 gün
    • 30 gün
    Boyut Boyutlar, ortamdaki herhangi bir TLS sertifikasına karşılık gelen Tüm TLS Sertifikaları değerine sabitlenir.
  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 Hedefi, seçilen kanal türüne göre belirtin:
    • E-posta: joe@company.com gibi bir e-posta adresi
    • Slack: https://hooks.slack.com/services/T00000000/B00000000/XXXXX gibi bir Slack kanalı URL'si
    • PagerDuty: abcd1234efgh56789 gibi PagerDuty kodu
    • Webhook: https://apigee.com/test-webhook gibi bir webhook URL'si

      Not: Bildirim başına yalnızca bir hedef belirtebilirsiniz. Aynı kanal türü için birden fazla hedef belirtmek istiyorsanız ek bildirimler ekleyin.
  6. Başka bildirimler eklemek için önceki adımı tekrarlayın.
  7. Bildirim eklediyseniz aşağıdaki alanları ayarlayın:
    Alan Açıklama
    Başucu Kitabı (İsteğe bağlı) Uyarılar tetiklendiğinde çözüme yönelik önerilen işlemlerin kısa bir açıklamasını sağlamak için serbest biçimli metin alanı. Ayrıca, en iyi uygulamalara referans verdiğiniz dahili wiki'nizin veya topluluk sayfanızın bağlantısını da belirtebilirsiniz. Bu alandaki bilgiler bildirime eklenir. Bu alandaki içerikler 1.500 karakteri aşamaz.
    Klape Bildirimlerin gönderilme 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 Edge kullanıcı arayüzündeki Events (Etkinlikler) kontrol paneline otomatik olarak kaydeder. Etkinlikler kontrol panelinde gösterilen etkinlik listesi, hem düzeltilmiş hem de sertifika olmak üzere tüm uyarıları içerir.

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

  1. Edge kullanıcı arayüzünde Analiz > Etkinlikler'i tıklayın. Yeni Etkinlikler kontrol paneli gösterilir:

  2. Etkinlikler kontrol panelini şunlara göre filtreleyin:

    • Ortam
    • Bölge
    • Dönem
  3. Süresi dolan sertifikayı içeren anahtar deposunu göstermek için Etkinlik kontrol panelinde bir satır seçin. Böylece uyarıyı daha ayrıntılı bir şekilde inceleyebilirsiniz. Anahtar deposu sayfasından yeni bir sertifika yükleyebilir ve süresi dolan sertifikayı silebilirsiniz.

Son kullanma tarihi uyarılarıyla birlikte uyarı API'lerini kullanma

Geçerlilik bitimi uyarılarını oluşturmak ve yönetmek için kullandığınız API'lerin çoğu, sabit uyarılarla kullandığınız API'lerle aynıdır. Aşağıdaki uyarı API'leri hem sabit hem de geçerlilik bitimi uyarılarında aynı şekilde çalışır:

Ancak bazı API'lerde anomali uyarılarını desteklemek için kullanılan ek özellikler vardır. Örneğin:

Son kullanma tarihi uyarısı oluşturma veya güncelleme

Sabit bir uyarı için yaptığınız gibi, aynı API'leri kullanarak bir geçerlilik tarihi uyarısı oluşturun veya güncelleyin. Bir geçerlilik uyarısı oluşturmak veya güncellemek için yapılan API çağrısının gövdesi, aşağıdaki değişikliklerle birlikte sabit bir uyarı için kullanılanla aynıdır:

  • Uyarının geçerlilik bitimi 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 bitişinin zaman aralığını en fazla 30 gün olacak şekilde saniye cinsinden 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 özellikleri desteklenmez.
  • reportEnabled özelliği, geçerlilik bitimi uyarıları için desteklenmez.

Aşağıdaki örnek API çağrısı, prod ortamındaki herhangi bir sertifikanın önümüzdeki 30 gün içinde süresi dolduğunda tetiklenen bir son kullanma tarihi uyarısı oluşturur. Uyarı tetiklendiğinde belirtilen e-posta adresine bildirim gönderilir:

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

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu edinme bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuz olarak ayarlayın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'ü kullanma başlıklı makaleyi inceleyin.

Son kullanma tarihi uyarıları alma

Get Alerts API'si, varsayılan olarak hem düzeltilmiş hem de geçerlilik süresi dolmuş olan tüm tanımlı uyarılarla ilgili bilgileri döndürür. Bu API artık sonuçları filtrelemenize olanak tanıyan sorgu parametrelerini kabul ediyor:

  • enabled: true yalnızca etkin uyarıların döndürülmesini belirtiyorsa. Varsayılan değer false'dır.
  • alertType: Döndürülecek uyarı türünü belirtir. İzin verilen değerler runtime (varsayılan) ve cert'dir.
  • alertSubType: Döndürülecek uyarı alt türünü belirtir. Varsayılan değer ayarlanmamıştır. Bu, tüm uyarı alt türlerinin döndürüleceği anlamına gelir. Geçerlilik süresi uyarılarını döndürmek için certfixed değerini belirtin.

Örneğin, myorg adlı kuruluş için yalnızca etkinleştirilmiş uyarıları 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ışı bırakılmış yalnızca geçerlilik bitimi 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'

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu edinme bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuz olarak ayarlayın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'ü kullanma başlıklı makaleyi inceleyin.