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.
Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von AWS Command Line Interface with API Gateway und Aktionen ausführen HTTP und allgemeine Szenarien implementieren WebSocket API.
Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Aktionen zeigen Ihnen zwar, wie Sie einzelne Servicefunktionen aufrufen, aber Sie können Aktionen im Kontext der zugehörigen Szenarien sehen.
Jedes Beispiel enthält einen Link zum vollständigen Quellcode, in dem Sie Anweisungen zum Einrichten und Ausführen des Codes im Kontext finden.
Themen
Aktionen
Das folgende Codebeispiel zeigt die Verwendungcreate-api-mapping
.
- AWS CLI
-
Um ein API Mapping für ein zu erstellen API
Im folgenden
create-api-mapping
Beispiel wird dietest
Phase von API an dem/myApi
Pfad desregional.example.com
benutzerdefinierten Domänennamens zugeordnet.aws apigatewayv2 create-api-mapping \ --domain-name
regional.example.com
\ --api-mapping-keymyApi
\ --api-ida1b2c3d4
\ --stagetest
Ausgabe:
{ "ApiId": "a1b2c3d4", "ApiMappingId": "0qzs2sy7bh", "ApiMappingKey": "myApi" "Stage": "test" }
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie CreateApiMapping
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztcreate-api
.
- AWS CLI
-
Um eine zu erstellen HTTP API
Im folgenden
create-api
Beispiel wird mithilfe HTTP API von Quick Create ein erstellt. Sie können Quick Create verwenden, um eine API mit AWS Lambda oder einer HTTP Integration, eine Standard-Catch-All-Route und eine Standardphase zu erstellen, die für die automatische Bereitstellung von Änderungen konfiguriert ist. Der folgende Befehl verwendet Quick Create, um eine zu erstellen HTTPAPI, die in eine Lambda-Funktion integriert ist.aws apigatewayv2 create-api \ --name
my-http-api
\ --protocol-typeHTTP
\ --targetarn:aws:lambda:us-west-2:123456789012:function:my-lambda-function
Ausgabe:
{ "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-08T19:05:45+00:00", "Name": "my-http-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path" }
Weitere Informationen finden Sie unter Entwickeln eines HTTP API API In-Gateways im Amazon API Gateway Developer Guide.
Um ein zu erstellen WebSocket API
Im folgenden
create-api
Beispiel wird eine WebSocket API mit dem angegebenen Namen erstellt.aws apigatewayv2 create-api \ --name
"myWebSocketApi"
\ --protocol-typeWEBSOCKET
\ --route-selection-expression '$request.body.action
'Ausgabe:
{ "ApiKeySelectionExpression": "$request.header.x-api-key", "Name": "myWebSocketApi", "CreatedDate": "2018-11-15T06:23:51Z", "ProtocolType": "WEBSOCKET", "RouteSelectionExpression": "'$request.body.action'", "ApiId": "aabbccddee" }
Weitere Informationen finden Sie unter Create a WebSocket API in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie CreateApi
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztcreate-authorizer
.
- AWS CLI
-
Um einen JWT Autorisierer für einen zu erstellen HTTP API
Im folgenden
create-authorizer
Beispiel wird ein JWT Autorisierer erstellt, der Amazon Cognito als Identitätsanbieter verwendet.aws apigatewayv2 create-authorizer \ --name
my-jwt-authorizer
\ --api-ida1b2c3d4
\ --authorizer-typeJWT
\ --identity-source '$request.header.Authorization
' \ --jwt-configurationAudience=123456abc,Issuer=https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123
Ausgabe:
{ "AuthorizerId": "a1b2c3", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "123456abc" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" }, "Name": "my-jwt-authorizer" }
Weitere Informationen finden Sie unter Steuern des Zugriffs HTTP APIs mit JWT Autorisierern im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter CreateAuthorizer AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztcreate-deployment
.
- AWS CLI
-
Um ein Deployment für ein zu erstellen API
Im folgenden
create-deployment
Beispiel wird eine Bereitstellung für eine erstellt API und diese Bereitstellung derdev
Phase von zugeordnetAPI.aws apigatewayv2 create-deployment \ --api-id
a1b2c3d4
\ --stage-namedev
Ausgabe:
{ "AutoDeployed": false, "CreatedDate": "2020-04-06T23:38:08Z", "DeploymentId": "53lz9l", "DeploymentStatus": "DEPLOYED" }
Weitere Informationen finden Sie unter APIBereitstellung im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie CreateDeployment
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztcreate-domain-name
.
- AWS CLI
-
Um einen benutzerdefinierten Domainnamen zu erstellen
Im folgenden
create-domain-name
Beispiel wird ein regionaler benutzerdefinierter Domainname für eine erstelltAPI.aws apigatewayv2 create-domain-name \ --domain-name
regional.example.com
\ --domain-name-configurationsCertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678
Ausgabe:
{ "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "regional.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789111", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ] }
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie CreateDomainName
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztcreate-integration
.
- AWS CLI
-
Um eine WebSocket API Integration zu erstellen
Das folgende
create-integration
Beispiel erstellt eine Scheinintegration für WebSocket API a.aws apigatewayv2 create-integration \ --api-id
aabbccddee
\ --passthrough-behaviorWHEN_NO_MATCH
\ --timeout-in-millis29000
\ --connection-typeINTERNET
\ --integration-typeMOCK
Ausgabe:
{ "ConnectionType": "INTERNET", "IntegrationId": "0abcdef", "IntegrationResponseSelectionExpression": "${integration.response.statuscode}", "IntegrationType": "MOCK", "PassthroughBehavior": "WHEN_NO_MATCH", "PayloadFormatVersion": "1.0", "TimeoutInMillis": 29000 }
Weitere Informationen finden Sie unter Einrichten einer WebSocket API Integrationsanfrage in API Gateway im Amazon API Gateway Developer Guide.
Um eine HTTP API Integration zu erstellen
Das folgende
create-integration
Beispiel erstellt eine AWS Lambda-Integration für eine HTTPAPI.aws apigatewayv2 create-integration \ --api-id
a1b2c3d4
\ --integration-typeAWS_PROXY
\ --integration-uriarn:aws:lambda:us-west-2:123456789012:function:my-function
\ --payload-format-version2.0
Ausgabe:
{ "ConnectionType": "INTERNET", "IntegrationId": "0abcdef", "IntegrationMethod": "POST", "IntegrationType": "AWS_PROXY", "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "PayloadFormatVersion": "2.0", "TimeoutInMillis": 30000 }
Weitere Informationen finden Sie unter Konfiguration von Integrationen für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie CreateIntegration
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztcreate-route
.
- AWS CLI
-
Um eine $default Route für ein WebSocket oder zu erstellen HTTP API
Das folgende
create-route
Beispiel erstellt eine$default
Route für ein WebSocket oder HTTPAPI.aws apigatewayv2 create-route \ --api-id
aabbccddee
\ --route-key '$default
'Ausgabe:
{ "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteKey": "$default", "RouteId": "1122334" }
Weitere Informationen finden Sie unter Arbeiten mit Routen für WebSocket APIs im Amazon API Gateway Developer Guide
Um eine Route für ein zu erstellen HTTP API
Im folgenden
create-route
Beispiel wird eine Route mit dem Namensignup
that accepting POST requests erstellt.aws apigatewayv2 create-route \ --api-id
aabbccddee
\ --route-key 'POST /signup
'Ausgabe:
{ "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteKey": "POST /signup", "RouteId": "1122334" }
Weitere Informationen finden Sie unter Arbeiten mit Routen für HTTP APIs im Amazon API Gateway Developer Guide
-
APIEinzelheiten finden Sie CreateRoute
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztcreate-stage
.
- AWS CLI
-
Um eine Phase zu erstellen
Im folgenden
create-stage
Beispiel wird eine Phase mit dem Namen dev für eine erstelltAPI.aws apigatewayv2 create-stage \ --api-id
a1b2c3d4
\ --stage-namedev
Ausgabe:
{ "CreatedDate": "2020-04-06T23:23:46Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "LastUpdatedDate": "2020-04-06T23:23:46Z", "RouteSettings": {}, "StageName": "dev", "StageVariables": {}, "Tags": {} }
Weitere Informationen finden Sie unter Working with Stages for HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie CreateStage
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztcreate-vpc-link
.
- AWS CLI
-
Um einen VPC Link für einen zu erstellen HTTP API
Das folgende
create-vpc-link
Beispiel erstellt einen VPC Link für HTTPAPIs.aws apigatewayv2 create-vpc-link \ --name
MyVpcLink
\ --subnet-idssubnet-aaaa
subnet-bbbb
\ --security-group-idssg1234
sg5678
Ausgabe:
{ "CreatedDate": "2020-04-07T00:11:46Z", "Name": "MyVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd123", "VpcLinkStatus": "PENDING", "VpcLinkStatusMessage": "VPC link is provisioning ENIs", "VpcLinkVersion": "V2" }
Weitere Informationen finden Sie unter Arbeiten mit VPC Links für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie CreateVpcLink
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-access-log-settings
.
- AWS CLI
-
Um die Zugriffsprotokollierung für ein zu deaktivieren API
Im folgenden
delete-access-log-settings
Beispiel werden die Zugriffsprotokolleinstellungen für die$default
Phase von gelöscht. API Um die Zugriffsprotokollierung für eine Phase zu deaktivieren, löschen Sie deren Zugriffsprotokolleinstellungen.aws apigatewayv2 delete-access-log-settings \ --api-id
a1b2c3d4
\ --stage-name '$default
'Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Konfiguration der Protokollierung für an HTTP API im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteAccessLogSettings
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-api-mapping
.
- AWS CLI
-
Um eine API Zuordnung zu löschen
Im folgenden
delete-api-mapping
Beispiel wird eine API Zuordnung für denapi.example.com
benutzerdefinierten Domänennamen gelöscht.aws apigatewayv2 delete-api-mapping \ --api-mapping-id
a1b2c3
\ --domain-nameapi.example.com
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteApiMapping
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-api
.
- AWS CLI
-
Um ein zu löschen API
Das folgende
delete-api
Beispiel löscht eineAPI.aws apigatewayv2 delete-api \ --api-id
a1b2c3d4
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Arbeiten mit HTTP APIs und Arbeiten mit WebSocket APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteApi
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-authorizer
.
- AWS CLI
-
Um einen Autorisierer zu löschen
Im folgenden
delete-authorizer
Beispiel wird ein Autorisierer gelöscht.aws apigatewayv2 delete-authorizer \ --api-id
a1b2c3d4
\ --authorizer-ida1b2c3
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Steuern des Zugriffs HTTP APIs mit JWT Autorisierern im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter DeleteAuthorizer AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-cors-configuration
.
- AWS CLI
-
Um die CORS Konfiguration für ein zu löschen HTTP API
Im folgenden
delete-cors-configuration
Beispiel wird die Funktion CORS für eine deaktiviert, HTTP API indem die zugehörige CORS Konfiguration gelöscht wird.aws apigatewayv2 delete-cors-configuration \ --api-id
a1b2c3d4
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Konfiguration CORS für eine HTTP API im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteCorsConfiguration
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-deployment
.
- AWS CLI
-
Um ein Deployment zu löschen
Das folgende
delete-deployment
Beispiel löscht eine Bereitstellung von. APIaws apigatewayv2 delete-deployment \ --api-id
a1b2c3d4
\ --deployment-ida1b2c3
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter APIBereitstellung im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteDeployment
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-domain-name
.
- AWS CLI
-
Um einen benutzerdefinierten Domainnamen zu löschen
Im folgenden
delete-domain-name
Beispiel wird ein benutzerdefinierter Domainname gelöscht.aws apigatewayv2 delete-domain-name \ --domain-name
api.example.com
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteDomainName
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-integration
.
- AWS CLI
-
Um eine Integration zu löschen
Das folgende
delete-integration
Beispiel löscht eine API Integration.aws apigatewayv2 delete-integration \ --api-id
a1b2c3d4
\ --integration-ida1b2c3
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Integrationen konfigurieren für HTTP APIs und Einrichten von WebSocket API Integrationen im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter DeleteIntegration AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-route-settings
.
- AWS CLI
-
Um Routeneinstellungen zu löschen
Im folgenden
delete-route-settings
Beispiel werden die Routeneinstellungen für die angegebene Route gelöscht.aws apigatewayv2 delete-route-settings \ --api-id
a1b2c3d4
\ --stage-namedev
\ --route-key 'GET /pets
'Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Arbeiten mit Routen für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteRouteSettings
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-route
.
- AWS CLI
-
Um eine Route zu löschen
Im folgenden
delete-route
Beispiel wird eine API Route gelöscht.aws apigatewayv2 delete-route \ --api-id
a1b2c3d4
\ --route-ida1b2c3
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Arbeiten mit Routen für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteRoute
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-stage
.
- AWS CLI
-
Um eine Phase zu löschen
Im folgenden
delete-stage
Beispiel wird dietest
Phase eines API gelöscht.aws apigatewayv2 delete-stage \ --api-id
a1b2c3d4
\ --stage-nametest
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Working with Stages for HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteStage
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztdelete-vpc-link
.
- AWS CLI
-
Um einen VPC Link für einen zu löschen HTTP API
Im folgenden
delete-vpc-link
Beispiel wird ein VPC Link gelöscht.aws apigatewayv2 delete-vpc-link \ --vpc-link-id
abcd123
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Arbeiten mit VPC Links für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie DeleteVpcLink
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztexport-api
.
- AWS CLI
-
Um eine API Open-Definition von zu exportieren HTTP API
Im folgenden
export-api
Beispiel wird eine Open API 3.0-Definition einer API Stagingstufe mit dem Namenprod
in eine YAML Datei mit dem Namen exportiertstage-definition.yaml
. Die exportierte Definitionsdatei enthält standardmäßig API Gateway-Erweiterungen.aws apigatewayv2 export-api \ --api-id
a1b2c3d4
\ --output-typeYAML
\ --specificationOAS30
\ --stage-nameprod
\stage-definition.yaml
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Exportieren eines HTTP API aus API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie ExportApi
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-api-mapping
.
- AWS CLI
-
Um Informationen über eine API Zuordnung für einen benutzerdefinierten Domainnamen zu erhalten
Im folgenden
get-api-mapping
Beispiel werden Informationen zu einer API Zuordnung für denapi.example.com
benutzerdefinierten Domainnamen angezeigt.aws apigatewayv2 get-api-mapping \ --api-mapping-id
a1b2c3
\ --domain-nameapi.example.com
Ausgabe:
{ "ApiId": "a1b2c3d4", "ApiMappingId": "a1b2c3d5", "ApiMappingKey": "myTestApi" "Stage": "test" }
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetApiMapping
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-api-mappings
.
- AWS CLI
-
Um API Zuordnungen für einen benutzerdefinierten Domainnamen abzurufen
Im folgenden
get-api-mappings
Beispiel wird eine Liste aller API Zuordnungen für denapi.example.com
benutzerdefinierten Domänennamen angezeigt.aws apigatewayv2 get-api-mappings \ --domain-name
api.example.com
Ausgabe:
{ "Items": [ { "ApiId": "a1b2c3d4", "ApiMappingId": "a1b2c3d5", "ApiMappingKey": "myTestApi" "Stage": "test" }, { "ApiId": "a5b6c7d8", "ApiMappingId": "a1b2c3d6", "ApiMappingKey": "myDevApi" "Stage": "dev" }, ] }
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetApiMappings
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-api
.
- AWS CLI
-
Um Informationen zu einem abzurufen API
Im folgenden
get-api
Beispiel werden Informationen zu einem angezeigtAPI.aws apigatewayv2 get-api \ --api-id
a1b2c3d4
Ausgabe:
{ "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-03-28T00:32:37Z", "Name": "my-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": { "department": "finance" } }
-
APIEinzelheiten finden Sie GetApi
unter AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-apis
.
- AWS CLI
-
Um eine Liste von abzurufen APIs
Das folgende
get-apis
Beispiel listet alle APIs für den aktuellen Benutzer auf.aws apigatewayv2 get-apis
Ausgabe:
{ "Items": [ { "ApiEndpoint": "wss://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-07T20:21:59Z", "Name": "my-websocket-api", "ProtocolType": "WEBSOCKET", "RouteSelectionExpression": "$request.body.message", "Tags": {} }, { "ApiEndpoint": "https://a1b2c3d5.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d5", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-07T20:23:50Z", "Name": "my-http-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": {} } ] }
Weitere Informationen finden Sie unter Arbeiten mit HTTP APIs und Arbeiten mit WebSocket APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetApis
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-authorizer
.
- AWS CLI
-
Um Informationen über einen Autorisierer abzurufen
Im folgenden
get-authorizer
Beispiel werden Informationen über einen Autorisierer angezeigt.aws apigatewayv2 get-authorizer \ --api-id
a1b2c3d4
\ --authorizer-ida1b2c3
Ausgabe:
{ "AuthorizerId": "a1b2c3", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "123456abc" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" }, "Name": "my-jwt-authorizer" }
Weitere Informationen finden Sie unter Steuern des Zugriffs HTTP APIs mit JWT Autorisierern im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter GetAuthorizer AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-authorizers
.
- AWS CLI
-
Um eine Liste von Autorisierern für ein abzurufen API
Im folgenden
get-authorizers
Beispiel wird eine Liste aller Autorisierer für eine angezeigt. APIaws apigatewayv2 get-authorizers \ --api-id
a1b2c3d4
Ausgabe:
{ "Items": [ { "AuthorizerId": "a1b2c3", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "123456abc" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" }, "Name": "my-jwt-authorizer" }, { "AuthorizerId": "a1b2c4", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "6789abcde" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc234" }, "Name": "new-jwt-authorizer" } ] }
Weitere Informationen finden Sie unter Steuern des Zugriffs HTTP APIs mit JWT Autorisierern im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter GetAuthorizers AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-deployment
.
- AWS CLI
-
Um Informationen über eine Bereitstellung abzurufen
Im folgenden
get-deployment
Beispiel werden Informationen zu einer Bereitstellung angezeigt.aws apigatewayv2 get-deployment \ --api-id
a1b2c3d4
\ --deployment-idabcdef
Ausgabe:
{ "AutoDeployed": true, "CreatedDate": "2020-04-07T23:58:40Z", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Automatic deployment triggered by changes to the Api configuration" }
Weitere Informationen finden Sie unter APIBereitstellung im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetDeployment
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-deployments
.
- AWS CLI
-
Um eine Liste von Bereitstellungen abzurufen
Im folgenden
get-deployments
Beispiel wird eine Liste aller Bereitstellungen API von an angezeigt.aws apigatewayv2 get-deployments \ --api-id
a1b2c3d4
Ausgabe:
{ "Items": [ { "AutoDeployed": true, "CreatedDate": "2020-04-07T23:58:40Z", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Automatic deployment triggered by changes to the Api configuration" }, { "AutoDeployed": true, "CreatedDate": "2020-04-06T00:33:00Z", "DeploymentId": "bcdefg", "DeploymentStatus": "DEPLOYED", "Description": "Automatic deployment triggered by changes to the Api configuration" } ] }
Weitere Informationen finden Sie unter APIBereitstellung im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetDeployments
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-domain-name
.
- AWS CLI
-
Um Informationen zu einem benutzerdefinierten Domainnamen abzurufen
Im folgenden
get-domain-name
Beispiel werden Informationen zu einem benutzerdefinierten Domainnamen angezeigt.aws apigatewayv2 get-domain-name \ --domain-name
api.example.com
Ausgabe:
{ "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "api.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789111", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ], "Tags": {} }
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetDomainName
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-domain-names
.
- AWS CLI
-
Um eine Liste mit benutzerdefinierten Domainnamen abzurufen
Im folgenden
get-domain-names
Beispiel wird eine Liste aller benutzerdefinierten Domänennamen für den aktuellen Benutzer angezeigt.aws apigatewayv2 get-domain-names
Ausgabe:
{ "Items": [ { "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "api.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789111", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ] }, { "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "newApi.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-5678.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789222", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ] } ] }
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetDomainNames
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-integration
.
- AWS CLI
-
Um Informationen über eine Integration abzurufen
Im folgenden
get-integration
Beispiel werden Informationen zu einer Integration angezeigt.aws apigatewayv2 get-integration \ --api-id
a1b2c3d4
\ --integration-ida1b2c3
Ausgabe:
{ "ApiGatewayManaged": true, "ConnectionType": "INTERNET", "IntegrationId": "a1b2c3", "IntegrationMethod": "POST", "IntegrationType": "AWS_PROXY", "IntegrationUri": "arn:aws:lambda:us-west-2:12356789012:function:hello12", "PayloadFormatVersion": "2.0", "TimeoutInMillis": 30000 }
Weitere Informationen finden Sie unter Integrationen konfigurieren für HTTP APIs und Einrichten von WebSocket API Integrationen im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter GetIntegration AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-integrations
.
- AWS CLI
-
Um eine Liste von Integrationen abzurufen
Das folgende
get-integrations
Beispiel zeigt eine Liste aller Integrationen API von an.aws apigatewayv2 get-integrations \ --api-id
a1b2c3d4
Ausgabe:
{ "Items": [ { "ApiGatewayManaged": true, "ConnectionType": "INTERNET", "IntegrationId": "a1b2c3", "IntegrationMethod": "POST", "IntegrationType": "AWS_PROXY", "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function", "PayloadFormatVersion": "2.0", "TimeoutInMillis": 30000 }, { "ConnectionType": "INTERNET", "IntegrationId": "a1b2c4", "IntegrationMethod": "ANY", "IntegrationType": "HTTP_PROXY", "IntegrationUri": "https://www.example.com", "PayloadFormatVersion": "1.0", "TimeoutInMillis": 30000 } ] }
Weitere Informationen finden Sie unter Integrationen konfigurieren für HTTP APIs und Einrichten von WebSocket API Integrationen im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter GetIntegrations AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-route
.
- AWS CLI
-
Um Informationen über eine Route abzurufen
Im folgenden
get-route
Beispiel werden Informationen zu einer Route angezeigt.aws apigatewayv2 get-route \ --api-id
a1b2c3d4
\ --route-id72jz1wk
Ausgabe:
{ "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "72jz1wk", "RouteKey": "ANY /pets", "Target": "integrations/a1b2c3" }
Weitere Informationen finden Sie unter Arbeiten mit Routen für HTTP APIs im Amazon API Gateway Developer Guide
-
APIEinzelheiten finden Sie GetRoute
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-routes
.
- AWS CLI
-
Um eine Liste von Routen abzurufen
Im folgenden
get-routes
Beispiel wird eine Liste aller Routen eines API Benutzers angezeigt.aws apigatewayv2 get-routes \ --api-id
a1b2c3d4
Ausgabe:
{ "Items": [ { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "72jz1wk", "RouteKey": "ANY /admin", "Target": "integrations/a1b2c3" }, { "ApiGatewayManaged": true, "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "go65gqi", "RouteKey": "$default", "Target": "integrations/a1b2c4" } ] }
Weitere Informationen finden Sie unter Arbeiten mit Routen für HTTP APIs im Amazon API Gateway Developer Guide
-
APIEinzelheiten finden Sie GetRoutes
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-stage
.
- AWS CLI
-
Um Informationen über eine Phase abzurufen
Im folgenden
get-stage
Beispiel werden Informationen zurprod
Phase eines angezeigtAPI.aws apigatewayv2 get-stage \ --api-id
a1b2c3d4
\ --stage-nameprod
Ausgabe:
{ "CreatedDate": "2020-04-08T00:36:05Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "DeploymentId": "x1zwyv", "LastUpdatedDate": "2020-04-08T00:36:13Z", "RouteSettings": {}, "StageName": "prod", "StageVariables": { "function": "my-prod-function" }, "Tags": {} }
Weitere Informationen finden Sie unter Working with Stages for HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetStage
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-stages
.
- AWS CLI
-
Um eine Liste von Stufen abzurufen
Das folgende
get-stages
Beispiel listet alle Phasen API von an auf.aws apigatewayv2 get-stages \ --api-id
a1b2c3d4
Ausgabe:
{ "Items": [ { "ApiGatewayManaged": true, "AutoDeploy": true, "CreatedDate": "2020-04-08T00:08:44Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "DeploymentId": "dty748", "LastDeploymentStatusMessage": "Successfully deployed stage with deployment ID 'dty748'", "LastUpdatedDate": "2020-04-08T00:09:49Z", "RouteSettings": {}, "StageName": "$default", "StageVariables": {}, "Tags": {} }, { "AutoDeploy": true, "CreatedDate": "2020-04-08T00:35:06Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "LastUpdatedDate": "2020-04-08T00:35:48Z", "RouteSettings": {}, "StageName": "dev", "StageVariables": { "function": "my-dev-function" }, "Tags": {} }, { "CreatedDate": "2020-04-08T00:36:05Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "DeploymentId": "x1zwyv", "LastUpdatedDate": "2020-04-08T00:36:13Z", "RouteSettings": {}, "StageName": "prod", "StageVariables": { "function": "my-prod-function" }, "Tags": {} } ] }
Weitere Informationen finden Sie unter Working with Stages for HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetStages
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-tags
.
- AWS CLI
-
Um eine Liste von Tags für eine Ressource abzurufen
Das folgende
get-tags
Beispiel listet alle Tags einer API Person auf.aws apigatewayv2 get-tags \ --resource-arn
arn:aws:apigateway:us-west-2::/apis/a1b2c3d4
Ausgabe:
{ "Tags": { "owner": "dev-team", "environment": "prod" } }
Weitere Informationen finden Sie unter Tagging your API Gateway-Ressourcen im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetTags
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-vpc-link
.
- AWS CLI
-
Um Informationen über einen VPC Link abzurufen
Im folgenden
get-vpc-link
Beispiel werden Informationen zu einem VPC Link angezeigt.aws apigatewayv2 get-vpc-link \ --vpc-link-id
abcd123
Ausgabe:
{ "CreatedDate": "2020-04-07T00:27:47Z", "Name": "MyVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd123", "VpcLinkStatus": "AVAILABLE", "VpcLinkStatusMessage": "VPC link is ready to route traffic", "VpcLinkVersion": "V2" }
Weitere Informationen finden Sie unter Arbeiten mit VPC Links für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetVpcLink
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztget-vpc-links
.
- AWS CLI
-
Um eine Liste von VPC Links abzurufen
Im folgenden
get-vpc-links
Beispiel wird eine Liste aller VPC Links für den aktuellen Benutzer angezeigt.aws apigatewayv2 get-vpc-links
Ausgabe:
{ "Items": [ { "CreatedDate": "2020-04-07T00:27:47Z", "Name": "MyVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd123", "VpcLinkStatus": "AVAILABLE", "VpcLinkStatusMessage": "VPC link is ready to route traffic", "VpcLinkVersion": "V2" } { "CreatedDate": "2020-04-07T00:27:47Z", "Name": "MyOtherVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd456", "VpcLinkStatus": "AVAILABLE", "VpcLinkStatusMessage": "VPC link is ready to route traffic", "VpcLinkVersion": "V2" } ] }
Weitere Informationen finden Sie unter Arbeiten mit VPC Links für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie GetVpcLinks
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztimport-api
.
- AWS CLI
-
Um ein zu importieren HTTP API
Im folgenden
import-api
Beispiel wird HTTP API aus einer Open API 3.0-Definitionsdatei eine Datei mit dem Namen erstelltapi-definition.yaml
.aws apigatewayv2 import-api \ --body
file://api-definition.yaml
Inhalt von
api-definition.yaml
:openapi: 3.0.1 info: title: My Lambda API version: v1.0 paths: /hello: x-amazon-apigateway-any-method: x-amazon-apigateway-integration: payloadFormatVersion: 2.0 type: aws_proxy httpMethod: POST uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:hello/invocations connectionType: INTERNET
Ausgabe:
{ "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-08T17:19:38+00:00", "Name": "My Lambda API", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": {}, "Version": "v1.0" }
Weitere Informationen finden Sie unter Arbeiten mit offenen API Definitionen für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie ImportApi
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztreimport-api
.
- AWS CLI
-
Um eine erneut zu importieren HTTP API
Im folgenden
reimport-api
Beispiel wird ein vorhandenes aktualisiert HTTPAPI, sodass es die inapi-definition.yaml
angegebene Open API 3.0-Definition verwendet.aws apigatewayv2 reimport-api \ --body
file://api-definition.yaml
\ --api-ida1b2c3d4
Inhalt von
api-definition.yaml
:openapi: 3.0.1 info: title: My Lambda API version: v1.0 paths: /hello: x-amazon-apigateway-any-method: x-amazon-apigateway-integration: payloadFormatVersion: 2.0 type: aws_proxy httpMethod: POST uri: arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:12356789012:function:hello/invocations connectionType: INTERNET
Ausgabe:
{ "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-04-08T17:19:38+00:00", "Name": "My Lambda API", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": {}, "Version": "v1.0" }
Weitere Informationen finden Sie unter Arbeiten mit offenen API Definitionen für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie ReimportApi
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutzttag-resource
.
- AWS CLI
-
Um eine Ressource zu taggen
Im folgenden
tag-resource
Beispiel wird ein Tag mit dem SchlüsselnamenDepartment
und dem angegebenen Wert hinzugefügtAPI.Accounting
aws apigatewayv2 tag-resource \ --resource-arn
arn:aws:apigateway:us-west-2::/apis/a1b2c3d4
\ --tagsDepartment=Accounting
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Tagging your API Gateway-Ressourcen im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie TagResource
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztuntag-resource
.
- AWS CLI
-
Um Tags aus einer Ressource zu entfernen
Im folgenden
untag-resource
Beispiel werden Tags mit den SchlüsselnamenProject
undOwner
aus den angegebenen Schlüsselnamen entferntAPI.aws apigatewayv2 untag-resource \ --resource-arn
arn:aws:apigateway:us-west-2::/apis/a1b2c3d4
\ --tag-keysProject
Owner
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Tagging your API Gateway-Ressourcen im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie UntagResource
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztupdate-api-mapping
.
- AWS CLI
-
Um ein API Mapping zu aktualisieren
Im folgenden
update-api-mapping
Beispiel wird eine API Zuordnung für einen benutzerdefinierten Domainnamen geändert. Dadurch wird die Basisstufe, die den URL benutzerdefinierten Domänennamen für die angegebene API Endstufe verwendet, zuhttps://api.example.com/dev
.aws apigatewayv2 update-api-mapping \ --api-id
a1b2c3d4
\ --stagedev
\ --domain-nameapi.example.com
\ --api-mapping-id0qzs2sy7bh
\ --api-mapping-keydev
Ausgabe:
{ "ApiId": "a1b2c3d4", "ApiMappingId": "0qzs2sy7bh", "ApiMappingKey": "dev" "Stage": "dev" }
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie UpdateApiMapping
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztupdate-api
.
- AWS CLI
-
Zur Aktivierung CORS für ein HTTP API
Im folgenden
update-api
Beispiel wird die angegebene API CORS Konfiguration aktualisiert, sodass Anfragen von möglich sindhttps://www.example.com
.aws apigatewayv2 update-api \ --api-id
a1b2c3d4
\ --cors-configurationAllowOrigins=https://www.example.com
Ausgabe:
{ "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CorsConfiguration": { "AllowCredentials": false, "AllowHeaders": [ "header1", "header2" ], "AllowMethods": [ "GET", "OPTIONS" ], "AllowOrigins": [ "https://www.example.com" ] }, "CreatedDate": "2020-04-08T18:39:37+00:00", "Name": "my-http-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "Tags": {}, "Version": "v1.0" }
Weitere Informationen finden Sie unter Konfiguration CORS für eine HTTP API im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie UpdateApi
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztupdate-authorizer
.
- AWS CLI
-
Um einen Autorisierer zu aktualisieren
Im folgenden
update-authorizer
Beispiel wird die Identitätsquelle eines JWT Autorisierers in einen Header mit dem Namen geändert.Authorization
aws apigatewayv2 update-authorizer \ --api-id
a1b2c3d4
\ --authorizer-ida1b2c3
\ --identity-source '$request.header.Authorization
'Ausgabe:
{ "AuthorizerId": "a1b2c3", "AuthorizerType": "JWT", "IdentitySource": [ "$request.header.Authorization" ], "JwtConfiguration": { "Audience": [ "123456abc" ], "Issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123" }, "Name": "my-jwt-authorizer" }
Weitere Informationen finden Sie unter Steuern des Zugriffs HTTP APIs mit JWT Autorisierern im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter UpdateAuthorizer AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztupdate-deployment
.
- AWS CLI
-
Um die Beschreibung einer Bereitstellung zu ändern
Im folgenden
update-deployment
Beispiel wird die Beschreibung einer Bereitstellung aktualisiert.aws apigatewayv2 update-deployment \ --api-id
a1b2c3d4
\ --deployment-idabcdef
\ --description 'Manual deployment to fix integration test failures.
'Ausgabe:
{ "AutoDeployed": false, "CreatedDate": "2020-02-05T16:21:48+00:00", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Manual deployment to fix integration test failures." }
Weitere Informationen finden Sie unter Entwickeln eines HTTP API API In-Gateways im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie UpdateDeployment
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztupdate-domain-name
.
- AWS CLI
-
Um einen benutzerdefinierten Domainnamen zu aktualisieren
Das folgende
update-domain-name
Beispiel spezifiziert ein neues ACM Zertifikat für denapi.example.com
benutzerdefinierten Domainnamen.aws apigatewayv2 update-domain-name \ --domain-name
api.example.com
\ --domain-name-configurationsCertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678
Ausgabe:
{ "ApiMappingSelectionExpression": "$request.basepath", "DomainName": "regional.example.com", "DomainNameConfigurations": [ { "ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com", "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678", "EndpointType": "REGIONAL", "HostedZoneId": "123456789111", "SecurityPolicy": "TLS_1_2", "DomainNameStatus": "AVAILABLE" } ] }
Weitere Informationen finden Sie unter Einrichtung eines regionalen benutzerdefinierten Domainnamens in API Gateway im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie UpdateDomainName
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztupdate-integration
.
- AWS CLI
-
Um eine Lambda-Integration zu aktualisieren
Im folgenden
update-integration
Beispiel wird eine bestehende AWS Lambda-Integration aktualisiert, sodass sie die angegebene Lambda-Funktion verwendet.aws apigatewayv2 update-integration \ --api-id
a1b2c3d4
\ --integration-ida1b2c3
\ --integration-uriarn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations
Ausgabe:
{ "ConnectionType": "INTERNET", "IntegrationId": "a1b2c3", "IntegrationMethod": "POST", "IntegrationType": "AWS_PROXY", "IntegrationUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations", "PayloadFormatVersion": "2.0", "TimeoutInMillis": 5000 }
Weitere Informationen finden Sie unter Integrationen konfigurieren für HTTP APIs und Einrichten von WebSocket API Integrationen im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter UpdateIntegration AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztupdate-route
.
- AWS CLI
-
Beispiel 1: Um die Integration einer Route zu aktualisieren
Das folgende
update-route
Beispiel aktualisiert die Integration einer angegebenen Route.aws apigatewayv2 update-route \ --api-id
a1b2c3d4
\ --route-ida1b2c3
\ --targetintegrations/a1b2c6
Ausgabe:
{ "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "a1b2c3", "RouteKey": "ANY /pets", "Target": "integrations/a1b2c6" }
Beispiel 2: Um einer Route einen Autorisierer hinzuzufügen
Im folgenden
update-route
Beispiel wird die angegebene Route aktualisiert, sodass sie einen JWT Autorisierer verwendet.aws apigatewayv2 update-route \ --api-id
a1b2c3d4
\ --route-ida1b2c3
\ --authorization-typeJWT
\ --authorizer-ida1b2c5
\ --authorization-scopesuser.id
user.email
Ausgabe:
{ "ApiKeyRequired": false, "AuthorizationScopes": [ "user.id", "user.email" ], "AuthorizationType": "JWT", "AuthorizerId": "a1b2c5", "OperationName": "GET HTTP", "RequestParameters": {}, "RouteId": "a1b2c3", "RouteKey": "GET /pets", "Target": "integrations/a1b2c6" }
Weitere Informationen finden Sie unter Steuern des Zugriffs HTTP APIs mit JWT Autorisierern im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie unter UpdateRoute AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztupdate-stage
.
- AWS CLI
-
Um eine benutzerdefinierte Drosselung zu konfigurieren
Im folgenden
update-stage
Beispiel wird die benutzerdefinierte Drosselung für die angegebene Phase und Route eines konfiguriert. APIaws apigatewayv2 update-stage \ --api-id
a1b2c3d4
\ --stage-namedev
\ --route-settings '{"GET /pets":{"ThrottlingBurstLimit":100,"ThrottlingRateLimit":2000}}
'Ausgabe:
{ "CreatedDate": "2020-04-05T16:21:16+00:00", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "DeploymentId": "shktxb", "LastUpdatedDate": "2020-04-08T22:23:17+00:00", "RouteSettings": { "GET /pets": { "ThrottlingBurstLimit": 100, "ThrottlingRateLimit": 2000.0 } }, "StageName": "dev", "StageVariables": {}, "Tags": {} }
Weitere Informationen finden Sie unter Protecting your HTTP API im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie UpdateStage
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt, wie man es benutztupdate-vpc-link
.
- AWS CLI
-
Um einen VPC Link zu aktualisieren
Im folgenden
update-vpc-link
Beispiel wird der Name eines VPC Links aktualisiert. Nachdem Sie einen VPC Link erstellt haben, können Sie seine Sicherheitsgruppen oder Subnetze nicht mehr ändern.aws apigatewayv2 update-vpc-link \ --vpc-link-id
abcd123
\ --nameMyUpdatedVpcLink
Ausgabe:
{ "CreatedDate": "2020-04-07T00:27:47Z", "Name": "MyUpdatedVpcLink", "SecurityGroupIds": [ "sg1234", "sg5678" ], "SubnetIds": [ "subnet-aaaa", "subnet-bbbb" ], "Tags": {}, "VpcLinkId": "abcd123", "VpcLinkStatus": "AVAILABLE", "VpcLinkStatusMessage": "VPC link is ready to route traffic", "VpcLinkVersion": "V2" }
Weitere Informationen finden Sie unter Arbeiten mit VPC Links für HTTP APIs im Amazon API Gateway Developer Guide.
-
APIEinzelheiten finden Sie UpdateVpcLink
in der AWS CLI Befehlsreferenz.
-