Nutzungspläne und API Schlüssel für REST APIs in API Gateway

Nachdem Sie Ihre erstellt, getestet und bereitgestellt habenAPIs, können Sie API Gateway-Nutzungspläne verwenden, um sie Ihren Kunden als Produktangebote zur Verfügung zu stellen. Sie können Nutzungspläne und API Schlüssel so konfigurieren, dass Kunden auf ausgewählte Pakete zugreifen könnenAPIs, und damit beginnen, Anfragen auf APIs Grundlage definierter Limits und Kontingente auf diese einzuschränken. Diese können auf Methodenebene oder auf API API Methodenebene festgelegt werden.

Was sind Nutzungspläne und API Schlüssel?

Ein Nutzungsplan legt fest, wer auf eine oder mehrere bereitgestellte API Stufen und Methoden zugreifen kann. Außerdem wird optional die Zielrate für Anfragen festgelegt, mit der die Drosselung von Anfragen gestartet werden soll. Der Plan verwendet API Schlüssel, um API Clients zu identifizieren und zu identifizieren, wer für jeden Schlüssel auf die zugehörigen API Stufen zugreifen kann.

APISchlüssel sind alphanumerische Zeichenkettenwerte, die Sie an Kunden von Anwendungsentwicklern verteilen, um ihnen Zugriff auf Ihre API zu gewähren. Sie können API Schlüssel zusammen mit Lambda-Autorisierern, IAMRollen oder Amazon Cognito verwenden, um den Zugriff auf Ihre zu kontrollieren. APIs APIGateway kann API Schlüssel in Ihrem Namen generieren oder Sie können sie aus einer Datei importieren. CSV Sie können einen API Schlüssel in API Gateway generieren oder ihn aus einer externen Quelle in API Gateway importieren. Weitere Informationen finden Sie unter Richten Sie API Schlüssel mit der Gateway-Konsole ein API.

Ein API Schlüssel hat einen Namen und einen Wert. (Die Begriffe „APISchlüssel“ und „APISchlüsselwert“ werden oft synonym verwendet.) Namen dürfen nicht mehr als 1024 Zeichen enthalten. Der Wert ist eine alphanumerische Zeichenfolge mit 20 bis 128 Zeichen, beispielsweise, apikey1234abcdefghij0123456789.

Wichtig

APISchlüsselwerte müssen eindeutig sein. Wenn Sie versuchen, zwei API Schlüssel mit unterschiedlichen Namen und demselben Wert zu erstellen, betrachtet API Gateway sie als denselben API Schlüssel.

Ein API Schlüssel kann mit mehr als einem Nutzungsplan verknüpft werden. Ein Nutzungsplan kann mehreren Stufen zugeordnet werden. Ein bestimmter API Schlüssel kann jedoch nur einem Nutzungsplan für jede Phase Ihres Abonnements zugeordnet werdenAPI.

Ein -Drosselungslimits legt den Zielpunkt fest, an dem die Anforderungsdrosselung beginnen soll. Dies kann auf API Methodenebene API oder festgelegt werden.

Ein Kontingentlimit legt die maximale Zielanzahl von Anfragen mit einem bestimmten API Schlüssel fest, die innerhalb eines bestimmten Zeitintervalls eingereicht werden können. Sie können einzelne API Methoden so konfigurieren, dass auf der Grundlage der Konfiguration des Nutzungsplans eine API Schlüsselautorisierung erforderlich ist.

Drosselung und Kontingentbeschränkungen gelten für Anfragen nach einzelnen API Schlüsseln, die in allen API Phasen eines Nutzungsplans zusammengefasst werden.

Anmerkung

Die -Drosselungsrate und die Kontingente der Nutzungspläne sind keine harten Grenzen und werden Best-Effort-Basis angewendet. In einigen Fällen können Kunden die von Ihnen festgelegten Kontingente überschreiten. Verlassen Sie sich nicht auf Kontingente oder Drosselung von Nutzungsplänen, um die Kosten zu kontrollieren oder den Zugriff auf einen zu blockieren. API Erwägen Sie AWS Budgetsden Einsatz zur Kostenüberwachung und Verwaltung AWS WAFAPIvon Anfragen.

Schritte zur Konfiguration eines Nutzungsplans und von API Schlüsseln in API Gateway

In den folgenden Aufgaben werden die erforderlichen Schritte zur Konfiguration eines Nutzungsplans und der API Schlüssel beschrieben. Bewährte Methoden finden Sie unter Bewährte Methoden für API Schlüssel und Nutzungspläne.

So konfigurieren Sie einen Nutzungsplan und API Schlüssel

1. Erstellen Sie eine Methodenanforderung API und konfigurieren Sie sie so, dass für jede API Methode ein API Schlüssel erforderlich ist. Stellen Sie Ihre dann API auf einer Stufe bereit.

   Um API Methoden in einen Nutzungsplan aufzunehmen, müssen Sie einzelne API Methoden so konfigurieren, dass sie einen API Schlüssel erfordern.

   Weitere Hinweise dazu, wie Sie eine Methode so konfigurieren, dass sie einen API Schlüssel erfordert, finden Sie unterErfordert einen API Schlüssel für eine Methode.

2. Generieren oder importieren Sie API Schlüssel, um sie an Anwendungsentwickler (Ihre Kunden) zu verteilen, die Ihren verwenden werdenAPI. APISchlüssel sind für Ihren Nutzungsplan erforderlich.

   Weitere Informationen zum Generieren oder Importieren von API Schlüsseln finden Sie unterErstellen Sie einen API Schlüssel.

3. Erstellen Sie den Nutzungsplan mit den gewünschten Drosselungs- und Kontingentgrenzen, und ordnen Sie dann API Stufen und API Schlüssel dem Nutzungsplan zu.

   Weitere Informationen zur Erstellung des Nutzungsplans finden Sie unterErstellen eines Nutzungsplans.

Aufrufer von API müssen in Anfragen an die einen zugewiesenen API Schlüssel im x-api-key Header angeben. API

Eine vollständige AWS CloudFormation Vorlage, mit der ein Nutzungsplan erstellt und mit einer neuen Phase und einem API Schlüssel verknüpft wird, finden Sie unterErstellen und konfigurieren Sie API Schlüssel und Nutzungspläne mit AWS CloudFormation.

Bewährte Methoden für API Schlüssel und Nutzungspläne

Im Folgenden werden bewährte Methoden für die Verwendung von API Schlüsseln und Nutzungsplänen empfohlen.

Wichtig

• Verwenden Sie keine API Schlüssel zur Authentifizierung oder Autorisierung, um den Zugriff auf Ihre zu kontrollierenAPIs. Wenn Sie mehrere APIs in einem Nutzungsplan haben, kann ein Benutzer mit einem gültigen API Schlüssel für einen API in diesem Nutzungsplan auf alle APIs in diesem Nutzungsplan zugreifen. Verwenden Sie stattdessen eine IAM Rolle, einen Lambda-Autorisierer oder einen Amazon Cognito Cognito-Benutzerpool, um den Zugriff auf Ihren API zu kontrollieren.

• Verwenden Sie API Schlüssel, die Gateway generiertAPI. APISchlüssel sollten keine vertraulichen Informationen enthalten. Clients übertragen sie normalerweise in Headern, die protokolliert werden können.

• Wenn Sie ein Entwicklerportal verwenden, um Ihre zu veröffentlichenAPIs, beachten Sie, dass alle Ihre Tarife APIs in einem bestimmten Nutzungsplan von Kunden abonniert werden können, auch wenn Sie sie für Ihre Kunden nicht sichtbar gemacht haben.

• In einigen Fällen können Kunden die von Ihnen festgelegten Kontingente überschreiten. Verlassen Sie sich nicht auf Nutzungspläne, um die Kosten zu kontrollieren. Erwägen Sie AWS Budgetsdie Nutzung zur Kostenüberwachung und AWS WAFVerwaltung von API Anfragen.

• Nachdem Sie einem Nutzungsplan einen API Schlüssel hinzugefügt haben, kann es einige Minuten dauern, bis der Aktualisierungsvorgang abgeschlossen ist.