Korzystanie z interfejsu API Monitoring API

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

Użyj interfejsu API Monitoring API do wykonywania poniższych zadań.

Działanie Więcej informacji
Zarządzaj alertami monitorowania interfejsów API
Zarządzaj kolekcjami na potrzeby monitorowania interfejsów API
Wyświetlaj logi monitorowania interfejsów API na różnych poziomach
Wyświetl wskaźniki monitorowania interfejsu API

Limity wywołań interfejsu API

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

Nie wszystkie interfejsy API mają takie same limity. Aby określić jego limit, zapoznaj się z dokumentacją API dotyczącą każdego z interfejsów API.

Użyj zwinięcia

W przykładach interfejsów API w tym dokumencie skorzystano z narzędzia curl, aby zademonstrować, jak korzystać z usługi API Monitoring przy użyciu interfejsu API. curl to narzędzie wiersza poleceń typu open source, które służy do przesyłania danych przy użyciu składni adresu URL i obsługuje popularne protokoły, takie jak HTTP i HTTPS. Więcej informacji o pobieraniu i korzystaniu z curl znajdziesz na https://curl.haxx.se/.

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

Opcja Opis
-d '{}'

--data @filename

Definiuje treść żądania przekazywaną bezpośrednio lub przez podanie nazwy pliku.
-H

--header

Definiuje nagłówek żądania. W nagłówku żądania musisz przekazać te informacje:
  • Token OAuth 2.0 do uwierzytelniania użytkowników przy użyciu 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łanego podczas tworzenia lub aktualizowania zasobu (POST, PATCH, PUT) za pomocą nagłówka Content-Type.
-i Wyświetla w odpowiedzi więcej informacji, takich jak nagłówki.
-X Określa typ żądania (GET, POST itd.).

Uzyskiwanie tokena dostępu OAuth 2.0

Apigee Edge obsługuje OAuth 2.0 na potrzeby uwierzytelniania użytkowników. W ramach protokołu OAuth 2.0 wymieniasz dane logowania Apigee Edge na token dostępu oraz token odświeżania, których możesz używać do bezpiecznych wywołań interfejsu Apigee Edge API. Po jego uzyskaniu nie musisz ponownie wymieniać danych logowania, dopóki token nie wygaśnie. Token odświeżania pozwala zachować „sesję” na serwerze przez dłuższy czas bez konieczności podawania danych logowania. Więcej informacji o tokenach dostępu znajdziesz w artykule Korzystanie z protokołu OAuth2 do uzyskiwania dostępu do interfejsu API zarządzania.

Korzystając z danych logowania Apigee Edge, możesz uzyskać dostęp OAuth 2.0 i tokeny odświeżania, aby uzyskać 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 na temat instalowania narzędzia get_token znajdziesz w artykule Korzystanie z metody get_token.

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

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

  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, używając nagłówka Authorization. Na przykład:


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