Amazon-EFS-API - Amazon Elastic File System

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.

Amazon-EFS-API

Die Amazon EFS-API ist ein Netzwerkprotokoll, das auf HTTP (RFC 2616) basiert. Für jeden API-Aufruf senden Sie eine HTTP-Anfrage an den regionsspezifischen Amazon EFS-API-Endpunkt für denAWS-Region Ort, an dem Sie Dateisysteme verwalten möchten. Die API nutzt JSON-Dokumente (RFC 4627) für die HTTP-Anforderungs-/Antworttexte.

Die Amazon EFS-API ist ein RPC-Modell. In diesem Modell gibt es einen festen Satz von Operationen, deren jeweilige Syntax den Clients ohne jede vorhergehende Interaktion bekannt ist. Im folgenden Abschnitt finden Sie eine Beschreibung für alle API-Operationen, die eine abstrakte RPC-Notation verwenden. Jeder verfügt über einen Operationsnamen, der nicht in den Wire-Daten zu sehen ist. Die jeweiligen Operationen werden den HTTP-Anforderungselementen zugeordnet.

Der spezifische Amazon EFS-Vorgang, dem eine bestimmte Anforderung zugeordnet wird, wird durch eine Kombination aus der Methode der Anfrage (GET, PUT, POST oder DELETE) und dem der verschiedenen Muster bestimmt, mit denen die Anforderungs-URI übereinstimmt. Wenn der Vorgang PUT oder POST ist, extrahiert Amazon EFS Aufrufargumente aus dem Request-URI-Pfadsegment, den Abfrageparametern und dem JSON-Objekt im Anforderungstext.

Anmerkung

Die Operationsnamen, wie etwa CreateFileSystem, sind zwar nicht in den Wire-Daten zu sehen, haben aber Bedeutung in den Richtlinien von AWS Identity and Access Management (IAM). Weitere Informationen finden Sie unter Identitäts- und Zugriffsmanagement für Amazon EFS.

Der Operationsname wird auch verwendet, um Befehle in Befehlszeilentools und Elementen derAWS SDK-APIs zu benennen. Beispielsweise gibt es einen AWS CLI-Befehl mit dem Namen create-file-system, der eine Zuordnung zur CreateFileSystem-Operation herstellt.

Der Vorgangsname erscheint auch in denAWS CloudTrail Protokollen für Amazon EFS-API-Aufrufe.

API-Endpunkt

Der API-Endpunkt ist der DNS-Name, der in dem HTTP-URI für die API-Aufrufe als Host verwendet wird. Diese API-Endpunkte sind spezifisch fürAWS-Regionen und haben die folgende Form.

elasticfilesystem.aws-region.amazonaws.com

Der Amazon EFS-API API Endpunkt für die Region USA West (Oregon) ist beispielsweise der folgende.

elasticfilesystem.us-west-2.amazonaws.com

Eine Liste der von AmazonAWS-Region EFS unterstützten Systeme (mit denen Sie Dateisysteme erstellen und verwalten können) finden Sie unter Amazon Elastic File System in der Allgemeine AWS-Referenz.

Der regionsspezifische API-Endpunkt definiert den Umfang der Amazon EFS-Ressourcen, auf die zugegriffen werden kann, wenn Sie einen API-Aufruf tätigen. Wenn Sie denDescribeFileSystems Vorgang beispielsweise mit dem vorherigen Endpunkt aufrufen, erhalten Sie eine Liste der Dateisysteme in der Region USA West (Oregon), die in Ihrem Konto erstellt wurden.

API-Version

Die für einen Aufruf verwendete API-Version wird vom ersten Pfadsegment des Anforderungs-URIs bestimmt und weist ein Datumsformat nach ISO 8601 auf. Für Beispiele vgl. CreateFileSystem.

Die Beschreibung in der Dokumentation bezieht sich auf die API-Version 2015-02-01.

In den folgenden Abschnitten erhalten Sie Beschreibungen der API-Operationen. Sie erfahren, wie Sie Signaturen zur Authentifizierung von Anforderungen erstellen und wie Sie mithilfe der IAM-Richtlinien Berechtigungen für die API-Operationen erteilen.

Arbeiten mit der Abfrage-API-Anforderungsrate für Amazon EFS

Amazon EFS-API-Anfragen werden für jedeAWS-Konto Region gedrosselt, um die Serviceleistung zu verbessern. Alle Amazon EFS-API-Aufrufe zusammen, unabhängig davon, ob sie von einer AnwendungAWS CLI, der oder der Amazon EFS-Konsole stammen, dürfen die maximal zulässige API-Anforderungsrate nicht überschreiten. Die maximale API-Anforderungsrate kann variierenAWS-Regionen. Die gestellten API-Anforderungen werden dem Basiswert zugeschriebenAWS-Konto.

Wenn eine API-Anforderung die API-Anforderungsrate für ihre Kategorie überschreitet, gibt die Anforderung den Fehlercode ThrottlingException zurück. Um diesen Fehler zu vermeiden, stellen Sie sicher, dass Ihre Anwendung API-Anfragen nicht in schneller Folge erneut versucht. Sie können dies tun, indem Sie beim Abrufen vorsichtig sind und Wiederholungen mit exponentiellem Backoff verwenden.

Abrufen

Möglicherweise muss Ihre Anwendung wiederholt eine API-Operation aufrufen, um auf ein Aktualisierung des Status zu prüfen. Bevor Sie mit dem Abrufen beginnen, geben Sie die Anforderungszeit für den potenziellen Abschluss ein. Wenn Sie mit dem Abrufen beginnen, verwenden Sie ein geeignetes Energiesparintervall zwischen aufeinanderfolgenden Anforderungen. Um die besten Ergebnisse zu erzielen, verwenden Sie ein zunehmendes Energiesparintervall.

Wiederholungsversuche oder Stapelverarbeitung

Ihre Anwendung muss möglicherweise eine API-Anfrage erneut versuchen, nachdem sie fehlgeschlagen ist, oder um mehrere Ressourcen zu verarbeiten (z. B. all Ihre Amazon EFS-Dateisysteme). Um die Rate von API-Anforderungen zu senken, verwenden Sie ein geeignetes Energiesparintervall zwischen aufeinanderfolgenden Anforderungen. Um die besten Ergebnisse zu erzielen, verwenden Sie ein zunehmendes oder variables Energiesparintervall.

Berechnen des Schlafintervalls

Wenn Sie eine API-Anforderung abrufen oder wiederholen müssen, empfehlen wir die Verwendung eines exponentiellen Backoff-Algorithmus zum Berechnen des Energiesparintervalls zwischen API-Aufrufen. Die Idee hinter dem exponentiellen Backoff ist, bei aufeinander folgenden Fehlermeldungen progressiv längere Wartezeiten zwischen den Wiederholversuchen zu verwenden. Weitere Informationen und Implementierungsbeispiele für diesen Algorithmus finden Sie unter Error Retries and Exponential BackoffAWS in der Allgemeine Amazon Web Services-Referenz.