Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Nachdem Sie Ihre erstellt, getestet und bereitgestellt haben APIs, können Sie API Gateway 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önnen APIs, und damit beginnen, Anfragen auf der APIs Grundlage definierter Limits und Kontingente auf diese einzuschränken. Diese können auf API- oder API-Methodenebene festgelegt werden.
Was sind Nutzungspläne und API-Schlüssel?
Ein Nutzungsplan gibt an, wer Zugriff auf eine oder mehrere bereitgestellte API-Stufen und Methoden hat. Es wird optional die Zielanforderungsrate festgelegt, um die Drosselungsrate der Anfragen zu starten. Der Plan verwendet API-Schlüssel zur Identifizierung von API-Clients und derjenigen, welche auf die zugehörigen API-Stufen jedes Schlüssels zugreifen können.
API-Schlüssel sind alphanumerische Zeichenfolgenwerte, mit denen Sie Anwendungsentwicklerkunden Zugriff auf Ihre API gewähren. Sie können API-Schlüssel zusammen mit Lambda-Autorisierern, IAM-Rollen oder Amazon Cognito verwenden, um den Zugriff auf Ihre zu kontrollieren. APIs API Gateway kann API-Schlüssel für Sie erstellen. Alternativ können Sie Schlüssel aus einer CSV-Datei importieren. Sie können einen API-Schlüssel in API Gateway erstellen oder ihn aus einer externen Quelle in API Gateway importieren. Weitere Informationen finden Sie unter Einrichten von API-Schlüsseln mit der API-Gateway-Konsole.
Ein API-Schlüssel verfügt über einen Namen und einen Wert. (Die Begriffe „API-Schlüssel” und „API-Schlüsselwert” werden häufig 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
API-Schlüsselwerte müssen eindeutig sein. Wenn Sie versuchen, zwei API-Schlüssel mit unterschiedlichen Namen und demselben Wert zu erstellen, hält API Gateway sie für ein- und denselben API-Schlüssel.
Ein API-Schlüssel kann mehreren Nutzungsplänen zugeordnet werden. Ein Nutzungsplan kann mehreren Stufen zugeordnet werden. Ein bestimmter API-Schlüssel kann jedoch nur einem Nutzungsplan für jede Stufe Ihres API zugeordnet werden.
Ein -Drosselungslimits legt den Zielpunkt fest, an dem die Anforderungsdrosselung beginnen soll. Dies kann auf API- oder API-Methodenebene festgelegt werden.
Ein Kontingentlimit legt die maximale Zielanzahl der Anforderungen fest, die mit einem bestimmten API-Schlüssel innerhalb eines vorgegebenen Zeitraums übermittelt werden können. Sie können einzelnen API-Methoden so konfigurieren, dass der API-Schlüssel autorisiert werden muss (abhängig von der Konfiguration des Nutzungsplans).
Die Drosselungs- und Kontingentlimits gelten für Anforderungen einzelner API-Schlüssel, die über alle API-Stufen eines Nutzungsplans aggregiert 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 Nutzungsplankontingente oder Drosseln, um Kosten zu kontrollieren oder den Zugriff auf eine API zu blockieren. Überlegen Sie sich, AWS Budgets zu verwenden, um Kosten zu überwachen und AWS WAF, um API-Anfragen zu verwalten.
Schritte für die Konfiguration eines Nutzungsplans und API-Schlüsseln in API Gateway
In den folgenden Aufgaben werden die Konfigurationsschritte für einen Nutzungsplan und API-Schlüssel dargelegt. Bewährte Methoden finden Sie unter Bewährte Methoden für API-Schlüssel und Nutzungspläne.
Konfigurieren eines Nutzungsplans und API-Schlüssel
-
Erstellen Sie eine API und konfigurieren Sie die Abfragemethode der einzelnen API-Methoden so, dass ein API-Schlüssel abgefragt wird. Stellen Sie dann Ihre API für eine Stufe bereit.
Um API-Methoden in einem Nutzungsplan aufzunehmen, müssen einzelne API-Methoden so konfiguriert werden, dass ein API-Schlüssel verlangt wird.
Weitere Informationen zur Methodenkonfigurierung für eine API-Schlüsselabfrage finden Sie unter Festlegen der Erforderlichkeit eines API-Schlüssels für eine Methode.
-
Generieren oder importieren Sie API-Schlüssel und verteilen Sie diese an die Anwendungsentwickler (Ihre Kunden), die Ihre API einsetzen werden. API-Schlüssel sind für Ihren Nutzungsplan erforderlich.
Weitere Informationen zur Generierung oder zum Import von API-Schlüsseln finden Sie unter Erstellen eines API-Schlüssels.
-
Erstellen Sie den Nutzungsplan mit den gewünschten Parametern zur Drosselung und den Quota-Limits und verknüpfen Sie anschließend API-Stufen und API-Schlüssel mit dem Nutzungsplan.
Weitere Informationen zur Erstellung des Nutzungsplans finden Sie unter Erstellen eines Nutzungsplans.
API-Aufrufer müssen bei Anforderungen an diese API einen zugewiesenen API-Schlüssel im Header x-api-key aufweisen.
Eine vollständige AWS CloudFormation Vorlage, die einen Nutzungsplan erstellt und mit einer neuen Phase und einem API-Schlüssel verknüpft, finden Sie unter. Erstellen 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 finden Sie empfohlene bewährte Methoden für die Verwendung von API-Schlüsseln und Nutzungsplänen.
Wichtig
-
Verwenden Sie keine API-Schlüssel zur Authentifizierung oder Autorisierung, um den Zugriff auf Ihre zu kontrollieren APIs. Wenn Sie mehrere APIs in einem Nutzungsplan haben, kann ein Benutzer mit einem gültigen API-Schlüssel für eine API in diesem Nutzungsplan auf alle APIs APIs in diesem Nutzungsplan zugreifen. Verwenden Sie für die Zugriffskontrolle auf Ihre API stattdessen eine IAM-Rolle, einen Lambda-Genehmiger oder einen Amazon Cognito-Benutzerpool.
-
Verwenden Sie API-Schlüssel, die API Gateway generiert. API-Schlü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öffentlichen APIs, beachten Sie, dass alle Ihre Daten 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. Ziehen Sie es in Betracht, AWS Budgets zu verwenden, um Kosten zu überwachen und AWS WAF, um API-Anfragen zu verwalten.
-
Der Aktualisierungsvorgang nach dem Hinzufügen eines API-Schlüssels zu einem Nutzungsplan kann ein paar Minuten dauern.
