Korzystanie z interfejsu API Monitoring API

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Aby wykonać te zadania, użyj interfejsu API zarządzania API Monitoring.

Zadanie Więcej informacji
Zarządzanie alertami w API Monitoring
Zarządzanie kolekcjami w API Monitoring
Wyświetlanie logów API Monitoring na różnych poziomach
Wyświetlanie wskaźników API Monitoring

Limity wywołań interfejsu API

Wszystkie interfejsy API API Monitoring mają limit, który ogranicza liczbę wywołań interfejsu API na minutę. Na przykład interfejs API Create collections ogranicza liczbę wywołań do 6 na minutę.

Nie wszystkie interfejsy API mają takie same limity. Aby określić limit, zapoznaj się z dokumentacją referencyjną interfejsu API.

Używanie curl

Przykłady interfejsu API w tym dokumencie używają curl do pokazania, jak korzystać z API Monitoring za pomocą interfejsu API. curl to narzędzie wiersza poleceń o otwartym kodzie źródłowym do przesyłania danych za pomocą składni URL, które obsługuje popularne protokoły, takie jak HTTP i HTTPS. Informacje o pobieraniu i używaniu curl znajdziesz na stronie https://curl.haxx.se/.

W tabeli poniżej znajdziesz podsumowanie opcji wiersza poleceń curl używanych w przykładach.

Opcja Opis
-d '{}'

--data @filename

Określa treść żądania, która jest przekazywana bezpośrednio lub przez podanie nazwy pliku.
-H

--header

Określa nagłówek żądania. W nagłówku żądania musisz podać te informacje:
  • Token OAuth 2.0 do uwierzytelniania użytkownika za pomocą nagłówka Authorization, zgodnie z opisem w sekcji Uzyskiwanie tokena dostępu OAuth 2.0.
  • Typy treści obsługiwane przez klienta za pomocą nagłówka Accept.
  • Typ treści treści żądania wysyłanej podczas tworzenia lub aktualizowania zasobu (POST, PATCH, PUT) za pomocą nagłówka Content-Type.
-i Wyświetla więcej informacji, np. nagłówki, w odpowiedzi.
-X Określa typ żądania (GET, POST itp.).

Uzyskiwanie tokena dostępu OAuth 2.0

Apigee Edge obsługuje OAuth 2.0 do uwierzytelniania użytkowników. Dzięki OAuth 2.0 możesz wymienić dane logowania Apigee Edge na token dostępu i token odświeżania, których możesz używać do bezpiecznego wywoływania interfejsu Apigee Edge API. Gdy uzyskasz token, nie musisz ponownie wymieniać danych logowania, dopóki token nie wygaśnie. Token odświeżania pozwala utrzymać „sesję” z serwerem przez dłuższy czas bez podawania danych logowania. Więcej informacji o tokenach dostępu znajdziesz w artykule Korzystanie z OAuth2 do uzyskiwania dostępu do interfejsu Management API.

Za pomocą danych logowania Apigee Edge możesz uzyskać tokeny dostępu i odświeżania OAuth 2.0, aby uzyskiwać dostęp do zasobów Apigee Edge za pomocą narzędzia get_token Apigee.

Aby uzyskać token dostępu OAuth 2.0:

  1. Zainstaluj narzędzie get_token. Informacje o instalowaniu narzędzia get_token znajdziesz w artykule Korzystanie z get_token.

  2. Uruchom get_token, aby uzyskać token dostępu OAuth 2.0.

    Gdy po raz pierwszy wpiszesz polecenie lub jeśli token odświeżania wygasł, get_token poprosi Cię o podanie nazwy użytkownika, hasła i 6-cyfrowego kodu uwierzytelniania dwuskładnikowego. Gdy pojawi się prośba, wpisz każdą wartość. Jeśli nie masz włączonego uwierzytelniania dwuskładnikowego, po prostu naciśnij Enter.

  3. Skopiuj token OAuth 2.0 i zapisz go w zmiennej, np. ACCESS_TOKEN: 

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

Gdy wywołujesz interfejs API Monitoring API, przekaż token dostępu OAuth 2.0 w nagłówku HTTP za pomocą nagłówka Authorization. Na przykład:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...