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.
Um API-Schlüssel einzurichten, gehen Sie wie folgt vor:
Konfigurieren Sie API-Methoden, um einen API-Schlüssel erforderlich zu machen.
Erstellen oder importieren Sie einen API-Schlüssel für die API in einer Region.
Vor der Einrichtung von API-Schlüsseln müssen Sie eine API erstellt haben und diese in einer Stufe bereitgestellt haben. Nach der Erstellung eines API-Schlüsselwerts kann dieser nicht geändert werden.
Informationen über REST-API-Aufrufe zum Erstellen und Bereitstellen einer API finden Sie unter restapi:create
und deployment:create
.
Anmerkung
Zu berücksichtigende bewährte Methoden finden Sie unter Bewährte Methoden für API-Schlüssel und Nutzungspläne.
Themen
Festlegen der Erforderlichkeit eines API-Schlüssels für eine Methode
Führen Sie einen der folgenden Schritte aus, damit für eine Methode ein API-Schlüssel erforderlich ist:
-
Rufen Sie
method:put
auf, um eine Methode zu erstellen. Legen SieapiKeyRequired
in der Anforderungsnutzlast auftrue
fest. -
Rufen Sie
method:update
auf, umapiKeyRequired
auftrue
zu setzen.
Erstellen oder Importieren von API-Schlüsseln
Führen Sie einen der folgenden Schritte aus, um einen API-Schlüssel zu erstellen oder zu importieren:
-
Rufen Sie
apikey:create
auf, um einen API-Schlüssel zu erstellen. -
Rufen Sie
apikey:import
auf, um einen API-Schlüssel aus einer Datei zu importieren. Weitere Informationen zum Dateiformat finden Sie unter API-Schlüsseldateiformat in API Gateway.
Sie können den Wert des neuen API-Schlüssels nicht ändern. Weitere Informationen zum Konfigurieren eines Nutzungsplans finden Sie unter Erstellen, Konfigurieren und Testen von Nutzungsplänen mittels API Gateway-CLI und REST-API.