Erstellen und Verwenden von Nutzungsplänen mit API-Schlüsseln

Nachdem Sie die APIs erstellt, getestet und bereitgestellt haben, können Sie API Gateway-Nutzungspläne verwenden, um die APIs als Produktangebot für Ihre Kunden bereitzustellen. Sie können Nutzungspläne und API-Schlüssel konfigurieren, um Kunden den Zugriff auf ausgewählte APIs zu ermöglichen, und damit beginnen, Anfragen an diese APIs basierend auf definierten Limits und Kontingenten zu drosseln. 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-Genehmigern, IAM-Rollen oder Amazon Cognito verwenden, um den Zugriff auf Ihre APIs zu steuern. 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.

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 für die Authentifizierung oder Autorisierung der Zugriffskontrolle für Ihre APIs. Zum Einen kann, falls sich mehrere APIs in einem Nutzungsplan befinden, ein Benutzer mit einem gültigen API-Schlüssel für eine API in diesem Nutzungsplan auf alle 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 zum Veröffentlichen Ihrer APIs ein Developer-Portal verwenden, beachten Sie auch, dass alle APIs in einem bestimmten Nutzungsplan abonnierbar sind, auch wenn Sie diese nicht extra für Ihre Kunden 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.

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