Brama interfejsu API w usłudze Azure API Management

DOTYCZY: Wszystkie warstwy usługi API Management

W tym artykule opisano role i funkcje składnika bramy usługi API Management. Porównuje również bramy, które można wdrożyć.

Powiązane informacje:

• Aby zapoznać się z omówieniem scenariuszy, składników i pojęć usługi API Management, zobacz Co to jest usługa Azure API Management?

• Aby uzyskać więcej informacji na temat warstw i funkcji usługi API Management, zobacz:

  • Poziomy zarządzania API
  • Porównanie warstw usługi Azure API Management oparte na funkcjach.

Rola bramy sieciowej

Brama API Management (nazywana także płaszczyzną danych lub środowiskiem uruchomieniowym) jest składnikiem usługi odpowiedzialnym za proxyowanie żądań API, stosowanie zasad i zbieranie danych telemetrycznych.

W szczególności brama:

• Działa jako warstwa pośrednia do usług backendowych, akceptując wywołania interfejsu API i przekierowując je do odpowiednich zapleczy
• Weryfikuje klucze interfejsu API i inne poświadczenia, takie jak tokeny JWT i certyfikaty przesyłane z żądaniami
• Wymusza kwoty użycia i limity szybkości
• Opcjonalnie przekształca żądania i odpowiedzi zgodnie z oświadczeniami polityki
• Jeśli skonfigurowano, buforuje odpowiedzi w celu poprawy szybkości reakcji i zminimalizowania obciążenia usług backendowych.
• Emituje dzienniki, metryki i ślady na potrzeby monitorowania, raportowania i rozwiązywania problemów

Bramy zarządzane i samodzielnie hostowane

Usługa API Management oferuje zarówno bramy zarządzane, jak i własne:

• Managed — Managed Gateway jest domyślnym komponentem bramy, który Azure wdraża dla każdego wystąpienia API Management w każdym poziomie usługi. Możesz również skojarzyć autonomiczną bramę zarządzaną z obszarem roboczym w wystąpieniu usługi API Management w wybranych warstwach usług. Korzystając z bramy zarządzanej, cały ruch interfejsów API przepływa przez platformę Azure niezależnie od tego, gdzie są hostowane zaplecza implementujące interfejsy API.

  Note

  Ze względu na różnice w podstawowej architekturze usługi bramy dostępne w różnych warstwach usługi API Management mają pewne różnice w możliwościach. Aby uzyskać szczegółowe informacje, zobacz sekcję Porównanie funkcji: Bramy zarządzane i samodzielnie hostowane.

• Self-hosted — Samodzielnie hostowana brama to opcjonalna, konteneryzowana wersja domyślnej bramy zarządzanej, dostępna w wybranych poziomach usług. Jest to przydatne w scenariuszach hybrydowych i wielochmurowych, w których wymagane jest uruchamianie bram poza platformą Azure w tych samych środowiskach, w których są hostowane zaplecza interfejsu API. Brama hostowana samodzielnie umożliwia klientom korzystanie z infrastruktury IT typu hybrydowego do zarządzania interfejsami API hostowanymi lokalnie i w różnych chmurach publicznych za pomocą jednej usługi zarządzania API w Azure.

  • Brama hostowana samodzielnie jest spakowana jako kontener platformy Docker oparty na systemie Linux i jest często wdrażana na platformie Kubernetes, w tym w usługach Azure Kubernetes Service i Kubernetes z obsługą usługi Azure Arc.

  • Każda brama samodzielnie hostowana jest skojarzona z zasobem bramy w wystąpieniu API Management hostowanym w chmurze, z którego otrzymuje aktualizacje konfiguracji i zgłasza stan.

Porównanie funkcji: bramy zarządzane i własne

Poniższe tabele porównują funkcje dostępne w następujących bramach usługi API Management:

• Klasyczny — brama zarządzana dostępna w warstwach usługi Developer, Basic, Standard i Premium (wcześniej pogrupowana jako warstwy dedykowane )
• V2 — brama zarządzana dostępna w warstwach Podstawowa v2, Standardowa v2 i Premium v2
• Użycie — brama zarządzana dostępna w warstwie Zużycie
• Self-hosted — opcjonalna brama zainstalowana na własnym serwerze, dostępna w wybranych warstwach usług
• Obszar roboczy - zarządzana brama dostępna w obszarze roboczym na wybranych poziomach usług

Infrastruktura

¹ Zależy od sposobu wdrażania bramy, ale odpowiada za to klient.
² Łączność z własnym punktem końcowym konfiguracji bramy w wersji 2 wymaga rozpoznawania NAZW DNS nazwy hosta punktu końcowego.
³ certyfikaty główne urzędu certyfikacji dla bramy hostowanej samodzielnie są zarządzane oddzielnie dla każdej bramy.
⁴ Należy włączyć protokół klienta.
⁵ . Skonfiguruj przy użyciu zasad żądania przesyłania dalej .
⁶ Skonfiguruj szczegóły certyfikatu urzędu certyfikacji dla uwierzytelniania certyfikatu backendowego w ustawieniach zaplecza.

Interfejsy API dla zaplecza

Policies

Bramy zarządzane i samodzielnie hostowane obsługują wszystkie dostępne zasady w definicjach zasad z następującymi wyjątkami. Zobacz dokumentację zasad, aby uzyskać szczegółowe informacje o poszczególnych zasadach.

¹ Skonfigurowane zasady, które nie są obsługiwane przez samodzielnie hostowaną bramę, są pomijane podczas wykonywania polityk.
² Limit szybkości według klucza, limitu przydziału według klucza i zasad limitu tokenów sztucznej inteligencji nie jest dostępny w warstwie Zużycie.
³ Liczniki limitów przepustowości w bramie samodzielnie hostowanej można skonfigurować do synchronizowania lokalnie (między wystąpieniami bramy w obrębie węzłów klastra), na przykład za pomocą wdrożenia Helm Chart dla platformy Kubernetes lub szablonów wdrożeniowych portalu Azure. Jednak wartości limitów szybkości nie są synchronizowane z innymi zasobami bramy skonfigurowanymi w wystąpieniu usługi API Management, w tym z bramą zarządzaną w chmurze. Dowiedz się więcej

Monitoring

Aby uzyskać szczegółowe informacje na temat opcji monitorowania, zobacz Obserwowanie w usłudze Azure API Management.

¹ Warstwy wersji v2 obsługują analizę opartą na usłudze Azure Monitor.
² Brama używa wbudowanego buforu pamięci usługi Azure Application Insights i nie zapewnia gwarancji dostarczania.
³ Brama hostowana samodzielnie nie wysyła obecnie dzienników zasobów (dzienników diagnostycznych) do usługi Azure Monitor. Opcjonalnie wyślij metryki do usługi Azure Monitor lub skonfiguruj i utrwalaj dzienniki lokalnie, gdzie wdrożono bramę, którą sam wdrożyłeś.

Uwierzytelnianie i autoryzacja

Bramy zarządzane i samodzielnie hostowane obsługują wszystkie dostępne opcje uwierzytelniania i autoryzacji API z następującymi wyjątkami.

Przepustowość i skalowanie bramy

Brama zarządzana

Aby uzyskać szacowaną maksymalną przepływność bramy w warstwach usługi API Management, zobacz Cennik usługi API Management.

• Poziomy klasyczne

  • Skaluj pojemność bramy, dodając lub usuwając jednostki skalowania, lub podwyższ poziom usług. (Skalowanie nie jest dostępne w warstwie Deweloper).
  • W warstwach Podstawowa, Standardowa i Premium opcjonalnie skonfiguruj automatyczne skalowanie usługi Azure Monitor.
  • W warstwie Premium można opcjonalnie dodać i rozdzielić pojemność bramy w wielu regionach.

• Poziomy v2

  • Skaluj pojemność bramy, dodając lub usuwając jednostki skalowania, lub podwyższ poziom usług.
  • Opcjonalnie skonfiguruj automatyczne skalowanie usługi Azure Monitor.

• Poziom zużycia

  • Wystąpienia usługi API Management w warstwie Zużycie są skalowane automatycznie w zależności od ruchu.

Brama hostowana lokalnie

• W środowiskach takich jak Kubernetes dodaj wiele replik bramy do obsługi oczekiwanego użycia.
• Opcjonalnie skonfiguruj skalowanie automatyczne w celu spełnienia wymagań dotyczących ruchu.

Brama obszaru roboczego

Zwiększaj pojemność przez dodawanie i usuwanie jednostek skali w bramie obszaru roboczego.

Punkt końcowy sprawdzania kondycji bramy sieciowej

We wszystkich warstwach z wyjątkiem warstwy Zużycie usługa Azure API Management udostępnia wbudowany punkt końcowy sprawdzania kondycji bramy w ścieżce /status-0123456789abcdef. Skontaktuj się z tym punktem końcowym, aby upewnić się, że brama interfejsu API jest dostępna i działa prawidłowo. Nie testuje interfejsów API zaplecza, tylko samej bramy.

Żądanie do punktu końcowego zwraca 200 OK odpowiedź HTTP, gdy brama jest sprawna; niepowodzenia wskazują problemy z siecią lub bramą.

• Platforma Azure używa tego punktu końcowego wewnętrznie do ciągłego monitorowania realizacji SLA i walidacji kondycji bramy.
• Klienci mogą integrować żądania do tego punktu końcowego z własnymi narzędziami monitorowania i sondami.
• Punkt końcowy jest dostępny dla bram zarządzanych (w tym bram regionalnych we wdrożeniach w wielu regionach), bram zainstalowanych lokalnie i bram obszarów roboczych.

Treści powiązane

Dowiedz się więcej o:

• Usługa API Management w świecie hybrydowym i wielochmurowym
• Metryka pojemności dla decyzji o skalowaniu
• Możliwości monitorowania w zarządzaniu API
• Funkcje bramki sztucznej inteligencji w zarządzaniu API