API-Referenzen - Amazon API Gateway

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.

API-Referenzen

Amazon API Gateway ermöglicht APIs die Erstellung und Bereitstellung Ihres eigenen HTTP- und WebSocket APIs. Darüber hinaus APIs sind API Gateway standardmäßig verfügbar AWS SDKs.

Wenn Sie eine Sprache verwenden, für die es ein AWS SDK gibt, ziehen Sie es möglicherweise vor, das SDK zu verwenden, anstatt das API-Gateway-REST APIs direkt zu verwenden. SDKs Sie vereinfachen die Authentifizierung, lassen sich problemlos in Ihre Entwicklungsumgebung integrieren und bieten einfachen Zugriff auf API Gateway Gateway-Befehle.

Hier finden Sie die REST-API-Referenzdokumentation AWS SDKs und die API Gateway REST-API-Referenzdokumentation:

Service-Endpunkte in API Gateway

Ein Endpunkt ist eine URL, die als Einstiegspunkt für einen AWS Webservice dient. API Gateway unterstützt die folgenden Endpunkttypen:

Wenn Sie eine Anfrage stellen, können Sie den zu verwendenden Endpunkt angeben. Wenn Sie keinen Endpunkt angeben, wird der IPv4 Endpunkt standardmäßig verwendet. Um einen anderen Endpunkttyp zu verwenden, müssen Sie ihn in Ihrer Anforderung angeben. Beispiele für diese Vorgehensweise finden Sie unter Angeben von Endpunkten. Eine Tabelle mit den verfügbaren Endpunkten finden Sie unter Endpunkte von Amazon API Gateway.

IPv4 Endpunkte

IPv4 Endpunkte unterstützen nur IPv4 Datenverkehr. IPv4 Endpunkte sind für alle Regionen verfügbar.

Wenn Sie den allgemeinen Endpunkt, apigateway.amazonaws.com, angeben, verwenden wir den Endpunkt für us-east-1. Um eine andere Region zu verwenden, geben Sie den zugehörigen Endpunkt an. Wenn Sie beispielsweise apigateway.us-east-2.amazonaws.com als Endpunkt angeben, leiten wir Ihre Anfrage an den us-east-2-Endpunkt weiter.

IPv4 Endpunktnamen verwenden die folgende Benennungskonvention:

  • apigateway.region.amazonaws.com

Der IPv4 Endpunktname für die eu-west-1 Region lautet beispielsweiseapigateway.eu-west-1.amazonaws.com.

Dual-Stack IPv4 - (und) Endpunkte IPv6

Dualstack-Endpunkte unterstützen sowohl den als auch den Datenverkehr. IPv4 IPv6 Wenn Sie eine Anfrage an einen Dual-Stack-Endpunkt stellen, wird die Endpunkt-URL je nach dem von Ihrem Netzwerk und Client verwendeten Protokoll in eine IPv6 oder eine IPv4 Adresse aufgelöst.

Dual-Stack-Endpunktnamen verwenden die folgende Namenskonvention:

  • apigateway.region.api.aws

Beispielsweise ist der Dual-Stack-Endpunktname für die Region eu-west-1 apigateway.eu-west-1.api.aws.

Angeben von Endpunkten

Die folgenden Beispiele zeigen, wie Sie mithilfe von for einen Endpunkt für die us-east-2 Region angeben. AWS CLI apigateway

  • Dualstack

    aws apigateway get-rest-apis --region us-east-2 --endpoint-url https://apigateway.us-east-2.api.aws
  • IPv4

    aws apigateway get-rest-apis --region us-east-2 --endpoint-url https://apigateway.us-east-2.amazonaws.com

Die folgenden Beispiele zeigen, wie Sie mithilfe von for einen Endpunkt AWS CLI für die us-east-2 Region angebenapigatewayv2.

  • Dualstack

    aws apigatewayv2 get-apis --region us-east-2 --endpoint-url https://apigateway.us-east-2.api.aws
  • IPv4

    aws apigatewayv2 get-apis --region us-east-2 --endpoint-url https://apigateway.us-east-2.amazonaws.com

IPv6 Adressen in IAM-Richtlinien verwenden

Wenn Sie IAM-Benutzerrichtlinien oder API Gateway-Ressourcenrichtlinien verwenden, um den Zugriff auf API Gateway oder ein beliebiges API Gateway zu steuern APIs, stellen Sie sicher, dass Ihre Richtlinien aktualisiert wurden und IPv6 Adressbereiche enthalten. Richtlinien, die nicht für den Umgang mit IPv6 Adressen aktualisiert wurden, können sich auf den Zugriff von Kunden auf API Gateway auswirken, wenn sie beginnen, den Dualstack-Endpunkt zu verwenden. Weitere Informationen über die Verwaltung von Zugriffsberechtigungen mit IAM finden Sie unter Identitäts- und Zugriffsverwaltung für Amazon API Gateway.

IAM-Richtlinien, die IP-Adressen filtern, verwenden Bedingungsoperatoren für IP-Adressen. Die folgende Identitätsrichtlinie ermöglicht es IP-Adressen in diesem 54.240.143.* Bereich, Informationen über alle Ressourcen eines HTTP- oder WebSocket APIs mit der Kennung von abzurufen. a123456789 Alle IP-Adressen außerhalb dieses Bereichs werden beim Zugriff auf Informationen zu den Ressourcen der API abgelehnt. Da alle IPv6 Adressen außerhalb des zulässigen Bereichs liegen, verhindert diese Richtlinie, dass IPv6 Adressen auf Informationen über die API zugreifen können.

JSON
{ "Version":"2012-10-17", "Statement": [ { "Sid": "IPAllow", "Effect": "Allow", "Principal": "*", "Action": "apigateway:GET", "Resource": "arn:aws:apigateway:us-east-1::/apis/a123456789/*", "Condition": { "IpAddress": {"aws:SourceIp": "54.240.143.0/24"} } } ] }

Sie können das Condition Element der API-Richtlinie so ändern, dass sowohl IPv4 (54.240.143.0/24) als auch IPv6 (2001:DB8:1234:5678::/64) Adressbereiche zulässig sind, wie im folgenden Beispiel gezeigt. Sie können denselben Typ von Condition-Block, der im Beispiel gezeigt wird, verwenden, um sowohl Ihre IAM-Benutzerrichtlinien als auch die API-Gateway-Ressourcensicherheitsrichtlinien zu aktualisieren.

"Condition": { "IpAddress": { "aws:SourceIp": [ "54.240.143.0/24", "2001:DB8:1234:5678::/64" ] } }