Otrzymywanie powiadomień z Sense

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
informacje

Możesz skonfigurować Apigee Sense tak, aby otrzymywać powiadomienia z listą wykrytych żądań interfejsu API, które mogą być niechciane. Po skonfigurowaniu powiadomień Apigee Sense co 5 minut wysyła raport na podany przez Ciebie adres URI webhooka.

Korzystając z identyfikatora URI webhooka, Apigee Sense wyśle ciąg tekstowy w formacie JSON (będziesz potrzebować kodu, który przeanalizuje ciąg tekstowy i przekształci go w dane w formacie JSON). Aby ułatwić czytelność, ten krótki przykład raportu został sformatowany z ciągu znaków do formatu JSON:

{
    "text": {
        "metadata": {
            "org": "my-org",
            "env": "prod",
            "reportTimestamp": "2018-10-09T17:25:12Z",
            "messageId": "1539105912220"
        },
        "totalNumberOfBots": 1,
        "bots": [
            {
                "ipAddress": "11.111.111.11",
                "botDetectedLast": "2018-10-0917:04:48Z",
                "ipIsp": "Their ISP",
                "ipCountry": "United States",
                "botReason": [
                    "Flooder",
                    "Content Robber"
                ],
                "callCount": "274529",
                "topUrl": "/v1/my/url",
                "ipCity": "Los Angeles"
            }
        ]
    }
}

Raport zawiera te informacje o potencjalnych niechcianych atakach na Twoje interfejsy API:

  • Organizacja i środowisko Apigee, w których zebrano zgłoszone żądania.
  • sygnatura czasowa raportu,
  • Identyfikator wiadomości do raportu.
  • Liczba adresów IP wysyłających żądania, które mogą być niepożądane.
  • Tablica danych klienta dotyczących adresów IP przesyłających potencjalnie niechciane żądania (na przykład boty). W przypadku każdego klienta raport zawiera:

    Właściwość klienta Opis
    ipAddress Adres IP klienta.
    botDetectedLast Sygnatura czasowa ostatniego żądania od klienta.
    ipIsp Dostawca usług internetowych klienta wysyłającego żądania.
    ipCountry Kraj, z którego pochodzą żądania od klienta.
    botReason reguły wykrywania Apigee Sense, którym odpowiadały żądania z tego adresu IP;
    callCount Liczba żądań z tego adresu IP.
    topUrl Najczęstszy URL żądany przez adres IP klienta. To jest interfejs API wymagany przez klienta.
    ipCity Miasto, z którego pochodzi żądanie.

Konfigurowanie powiadomień

  1. Otwórz nową wersję Edge.
  2. W nowej wersji Edge kliknij menu Analizuj, a następnie Sense.
  3. Kliknij menu Ustawienia.
  4. Na stronie Ustawienia wpisz wartości, aby skonfigurować powiadomienia:

    Ustawienie Opis
    Powiadomienie Kliknij, aby włączyć lub wyłączyć to powiadomienie.
    Identyfikator URI Identyfikator URI, którego Apigee ma używać do wysyłania powiadomień. Zwykle jest to system monitorowania, który akceptuje przychodzące webhooki. Raporty z Apigee Sense będą wysyłane na ten adres URI.
    Nazwa klucza interfejsu API Opcjonalnie: Nazwa klucza, którego Apigee Sense powinien używać podczas uwierzytelniania w Twoim systemie. Aby zwiększyć bezpieczeństwo, użyj klucza interfejsu API.
    Wartość klucza API Opcjonalnie: Wartość klucza, której Apigee Sense ma używać podczas uwierzytelniania w Twoim systemie. Użyj klucza interfejsu API, aby zwiększyć bezpieczeństwo.
    Maksymalna liczba adresów IP Maksymalna liczba adresów IP klienta (od 1 do 300), które mają być uwzględnione w raporcie. Apigee Sense uwzględnia adresy IP w kolejności od żądań o największym prawdopodobieństwie do tych o najmniejszym prawdopodobieństwie, aż do podanych przez Ciebie adresów IP.