使用 AWS CLI 的 API Gateway HTTP 和 WebSocket API 示例

为 API 创建 API 映射

以下 create-api-mapping 示例将 API 的 test 阶段映射到 regional.example.com 自定义域名的 /myApi 路径。

aws apigatewayv2 create-api-mapping \
    --domain-name regional.example.com \
    --api-mapping-key myApi \
    --api-id a1b2c3d4 \
    --stage test

输出：

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "0qzs2sy7bh",
    "ApiMappingKey": "myApi"
    "Stage": "test"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

创建 HTTP API

以下 create-api 示例使用“快速创建”功能创建一个 HTTP API。您可以使用“快速创建”功能，创建具有 AWS Lambda 或 HTTP 集成、默认“捕获全部”路由和默认阶段（配置为自动部署更改）的 API。以下命令使用“快速创建”功能创建与 Lambda 函数集成的 HTTP API。

aws apigatewayv2 create-api \
    --name my-http-api \
    --protocol-type HTTP \
    --target arn:aws:lambda:us-west-2:123456789012:function:my-lambda-function

输出：

{
    "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"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中开发 HTTP API。

创建 WebSocket API

以下 create-api 示例创建一个具有指定名称的 WebSocket API。

aws apigatewayv2 create-api \
    --name "myWebSocketApi" \
    --protocol-type WEBSOCKET \
    --route-selection-expression '$request.body.action'

输出：

{
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "Name": "myWebSocketApi",
    "CreatedDate": "2018-11-15T06:23:51Z",
    "ProtocolType": "WEBSOCKET",
    "RouteSelectionExpression": "'$request.body.action'",
    "ApiId": "aabbccddee"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中创建 WebSocket API。

为 HTTP API 创建 JWT 授权方

以下 create-authorizer 示例创建使用 Amazon Cognito 作为身份提供商的 JWT 授权方。

aws apigatewayv2 create-authorizer \
    --name my-jwt-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-type JWT \
    --identity-source '$request.header.Authorization' \
    --jwt-configuration Audience=123456abc,Issuer=https://cognito-idp.us-west-2.amazonaws.com/us-west-2_abc123

输出：

{
    "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"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 JWT 授权方控制对 HTTP API 的访问。

为 API 创建部署

以下 create-deployment 示例创建 API 的部署并将该部署与 API 的 dev 阶段关联。

aws apigatewayv2 create-deployment \
    --api-id a1b2c3d4 \
    --stage-name dev

输出：

{
    "AutoDeployed": false,
    "CreatedDate": "2020-04-06T23:38:08Z",
    "DeploymentId": "53lz9l",
    "DeploymentStatus": "DEPLOYED"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的 API 部署。

创建自定义域名

以下 create-domain-name 示例为 API 创建一个区域自定义域名。

aws apigatewayv2 create-domain-name \
    --domain-name regional.example.com \
    --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

输出：

{
    "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"
        }
    ]
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

创建 WebSocket API 集成

以下 create-integration 示例为 WebSocket API 创建一个模拟集成。

aws apigatewayv2 create-integration \
    --api-id aabbccddee \
    --passthrough-behavior WHEN_NO_MATCH \
    --timeout-in-millis 29000 \
    --connection-type INTERNET \
    --integration-type MOCK

输出：

{
    "ConnectionType": "INTERNET",
    "IntegrationId": "0abcdef",
    "IntegrationResponseSelectionExpression": "${integration.response.statuscode}",
    "IntegrationType": "MOCK",
    "PassthroughBehavior": "WHEN_NO_MATCH",
    "PayloadFormatVersion": "1.0",
    "TimeoutInMillis": 29000
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置 WebSocket API 集成请求。

创建 HTTP API 集成

以下 create-integration 示例为 HTTP API 创建 AWS Lambda 集成。

aws apigatewayv2 create-integration \
    --api-id a1b2c3d4 \
    --integration-type AWS_PROXY \
    --integration-uri arn:aws:lambda:us-west-2:123456789012:function:my-function \
    --payload-format-version 2.0

输出：

{
    "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
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的为 HTTP API 配置集成。

为 WebSocket 或 HTTP API 创建 $default 路由

以下 create-route 示例为 WebSocket 或 HTTP API 创建 $default 路由。

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key '$default'

输出：

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "$default",
    "RouteId": "1122334"
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 WebSocket API 的路由。

为 HTTP API 创建路由

以下 create-route 示例创建一个接受 POST 请求的名为 signup 的路由。

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key 'POST /signup'

输出：

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "POST /signup",
    "RouteId": "1122334"
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的路由。

创建阶段

以下 create-stage 示例为 API 创建一个名为 dev 的阶段。

aws apigatewayv2 create-stage \
    --api-id a1b2c3d4 \
    --stage-name dev

输出：

{
    "CreatedDate": "2020-04-06T23:23:46Z",
    "DefaultRouteSettings": {
        "DetailedMetricsEnabled": false
    },
    "LastUpdatedDate": "2020-04-06T23:23:46Z",
    "RouteSettings": {},
    "StageName": "dev",
    "StageVariables": {},
    "Tags": {}
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的阶段。

为 HTTP API 创建 VPC 链接

以下 create-vpc-link 示例为 HTTP API 创建 VPC 链接。

aws apigatewayv2 create-vpc-link \
    --name MyVpcLink \
    --subnet-ids subnet-aaaa subnet-bbbb \
    --security-group-ids sg1234 sg5678

输出：

{
    "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"
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的 VPC 链接。

禁用 API 的访问日志记录

以下 delete-access-log-settings 示例删除 API $default 阶段的访问日志设置。要禁用阶段的访问日志记录，请删除其访问日志设置。

aws apigatewayv2 delete-access-log-settings \
    --api-id a1b2c3d4 \
    --stage-name '$default'

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的为 HTTP API 配置日志记录。

删除 API 映射

以下 delete-api-mapping 示例删除 api.example.com 自定义域名的 API 映射。

aws apigatewayv2 delete-api-mapping \
    --api-mapping-id a1b2c3 \
    --domain-name api.example.com

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

删除 API

以下 delete-api 示例删除 API。

aws apigatewayv2 delete-api \
    --api-id a1b2c3d4

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 和使用 WebSocket API。

删除授权方

以下 delete-authorizer 示例删除授权方。

aws apigatewayv2 delete-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 JWT 授权方控制对 HTTP API 的访问。

删除 HTTP API 的 CORS 配置

以下 delete-cors-configuration 示例通过删除 HTTP API 的 CORS 配置来禁用 HTTP API 的 CORS。

aws apigatewayv2 delete-cors-configuration \
    --api-id a1b2c3d4

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的为 HTTP API 配置 CORS。

删除部署

以下 delete-deployment 示例删除 API 的部署。

aws apigatewayv2 delete-deployment \
    --api-id a1b2c3d4 \
    --deployment-id a1b2c3

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的 API 部署。

删除自定义域名

以下 delete-domain-name 示例删除一个自定义域名。

aws apigatewayv2 delete-domain-name \
    --domain-name api.example.com

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

删除集成

以下 delete-integration 示例删除 API 集成。

aws apigatewayv2 delete-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的为 HTTP API 配置集成和设置 WebSocket API 集成。

删除路由设置

以下 delete-route-settings 示例删除指定路由的路由设置。

aws apigatewayv2 delete-route-settings \
    --api-id a1b2c3d4 \
    --stage-name dev \
    --route-key 'GET /pets'

此命令不生成任何输出。

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的路由。

删除路由

以下 delete-route 示例删除 API 路由。

aws apigatewayv2 delete-route \
    --api-id a1b2c3d4 \
    --route-id a1b2c3

此命令不生成任何输出。

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的路由。

删除阶段

以下 delete-stage 示例删除 API 的 test 阶段。

aws apigatewayv2 delete-stage \
    --api-id a1b2c3d4 \
    --stage-name test

此命令不生成任何输出。

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的阶段。

删除 HTTP API 的 VPC 链接

以下 delete-vpc-link 示例删除 VPC 链接。

aws apigatewayv2 delete-vpc-link \
    --vpc-link-id abcd123

此命令不生成任何输出。

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的 VPC 链接。

导出 HTTP API 的 OpenAPI 定义

以下 export-api 示例将名为 prod 的 API 阶段的 OpenAPI 3.0 定义导出到名为 stage-definition.yaml 的 YAML 文件。默认情况下，导出的定义文件包含 API Gateway 扩展名。

aws apigatewayv2 export-api \
    --api-id a1b2c3d4 \
    --output-type YAML \
    --specification OAS30 \
    --stage-name prod \
    stage-definition.yaml

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的从 API Gateway 导出 HTTP API。

获取有关自定义域名的 API 映射的信息

以下 get-api-mapping 示例显示有关 api.example.com 自定义域名的 API 映射的信息。

aws apigatewayv2 get-api-mapping \
    --api-mapping-id a1b2c3 \
    --domain-name api.example.com

输出：

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "a1b2c3d5",
    "ApiMappingKey": "myTestApi"
    "Stage": "test"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

获取自定义域名的 API 映射

以下 get-api-mappings 示例显示 api.example.com 自定义域名的所有 API 映射列表。

aws apigatewayv2 get-api-mappings \
    --domain-name api.example.com

输出：

{
    "Items": [
        {
            "ApiId": "a1b2c3d4",
            "ApiMappingId": "a1b2c3d5",
            "ApiMappingKey": "myTestApi"
            "Stage": "test"
        },
        {
            "ApiId": "a5b6c7d8",
            "ApiMappingId": "a1b2c3d6",
            "ApiMappingKey": "myDevApi"
            "Stage": "dev"
        },
    ]
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

检索有关 API 的信息

以下 get-api 示例显示有关 API 的信息。

aws apigatewayv2 get-api \
    --api-id a1b2c3d4

输出：

{
    "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"
    }
}

检索 API 列表

以下 get-apis 示例列出当前用户的所有 API。

aws apigatewayv2 get-apis

输出：

{
    "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": {}
        }
    ]
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 和使用 WebSocket API。

检索有关授权方的信息

以下 get-authorizer 示例显示有关授权方的信息。

aws apigatewayv2 get-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3

输出：

{
    "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"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 JWT 授权方控制对 HTTP API 的访问。

检索 API 的授权方列表

以下 get-authorizers 示例显示 API 的所有授权方的列表。

aws apigatewayv2 get-authorizers \
    --api-id a1b2c3d4

输出：

{
    "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"
        }
    ]
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 JWT 授权方控制对 HTTP API 的访问。

检索有关部署的信息

以下 get-deployment 示例显示有关部署的信息。

aws apigatewayv2 get-deployment \
    --api-id a1b2c3d4 \
    --deployment-id abcdef

输出：

{
    "AutoDeployed": true,
    "CreatedDate": "2020-04-07T23:58:40Z",
    "DeploymentId": "abcdef",
    "DeploymentStatus": "DEPLOYED",
    "Description": "Automatic deployment triggered by changes to the Api configuration"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的 API 部署。

检索部署列表

以下 get-deployments 示例显示所有 API 部署的列表。

aws apigatewayv2 get-deployments \
    --api-id a1b2c3d4

输出：

{
    "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"
        }
    ]
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的 API 部署。

检索有关自定义域名的信息

以下 get-domain-name 示例显示有关自定义域名的信息。

aws apigatewayv2 get-domain-name \
    --domain-name api.example.com

输出：

{
    "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": {}
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

检索自定义域名列表

以下 get-domain-names 示例显示当前用户的所有自定义域名列表。

aws apigatewayv2 get-domain-names

输出：

{
    "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"
                }
            ]
        }
    ]
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

检索有关集成的信息

以下 get-integration 示例显示有关集成的信息。

aws apigatewayv2 get-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3

输出：

{
    "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
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的为 HTTP API 配置集成和设置 WebSocket API 集成。

检索集成列表

以下 get-integrations 示例显示所有 API 集成的列表。

aws apigatewayv2 get-integrations \
    --api-id a1b2c3d4

输出：

{
    "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
        }
    ]
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的为 HTTP API 配置集成和设置 WebSocket API 集成。

检索有关路由的信息

以下 get-route 示例显示有关路由的信息。

aws apigatewayv2 get-route \
    --api-id a1b2c3d4 \
    --route-id 72jz1wk

输出：

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteId": "72jz1wk",
    "RouteKey": "ANY /pets",
    "Target": "integrations/a1b2c3"
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的路由。

检索路由列表

以下 get-routes 示例显示所有 API 路由的列表。

aws apigatewayv2 get-routes \
    --api-id a1b2c3d4

输出：

{
    "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"
        }
    ]
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的路由。

检索有关阶段的信息

以下 get-stage 示例显示有关 API prod 阶段的信息。

aws apigatewayv2 get-stage \
    --api-id a1b2c3d4 \
    --stage-name prod

输出：

{
    "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": {}
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的阶段。

检索阶段列表

以下 get-stages 示例列出 API 的所有阶段。

aws apigatewayv2 get-stages \
    --api-id a1b2c3d4

输出：

{
    "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": {}
        }
    ]
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的阶段。

检索资源的标签列表

以下 get-tags 示例列出 API 的所有标签。

aws apigatewayv2 get-tags \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4

输出：

{
    "Tags": {
        "owner": "dev-team",
        "environment": "prod"
    }
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的标记您的 API Gateway 资源。

检索有关 VPC 链接的信息

以下 get-vpc-link 示例显示有关 VPC 链接的信息。

aws apigatewayv2 get-vpc-link \
    --vpc-link-id abcd123

输出：

{
    "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"
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的 VPC 链接。

检索 VPC 链接列表

以下 get-vpc-links 示例显示当前用户所有 VPC 链接的列表。

aws apigatewayv2 get-vpc-links

输出：

{
    "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"
        }
    ]
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的 VPC 链接。

导入 HTTP API

以下 import-api 示例从名为 api-definition.yaml 的 OpenAPI 3.0 定义文件创建 HTTP API。

aws apigatewayv2 import-api \
    --body file://api-definition.yaml

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

输出：

{
    "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"
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的 OpenAPI 定义。

重新导入 HTTP API

以下 reimport-api 示例将现有 HTTP API 更新为使用 api-definition.yaml 中指定的 OpenAPI 3.0 定义。

aws apigatewayv2 reimport-api \
    --body file://api-definition.yaml \
    --api-id a1b2c3d4

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

输出：

{
    "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"
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的 OpenAPI 定义。

标记资源

以下 tag-resource 示例向指定的 API 添加了键名称为 Department 和值为 Accounting 的标签。

aws apigatewayv2 tag-resource \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
    --tags Department=Accounting

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的标记您的 API Gateway 资源。

从资源中删除标签

以下 untag-resource 示例从指定 API 中移除键名为 Project 和 Owner 的标签。

aws apigatewayv2 untag-resource \
    --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \
    --tag-keys Project Owner

此命令不生成任何输出。

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的标记您的 API Gateway 资源。

更新 API 映射

以下 update-api-mapping 示例更改自定义域名的 API 映射。这样，使用指定 API 和阶段的自定义域名的基础 URL 会变为 https://api.example.com/dev。

aws apigatewayv2 update-api-mapping \
    --api-id a1b2c3d4 \
    --stage dev \
    --domain-name api.example.com \
    --api-mapping-id 0qzs2sy7bh \
    --api-mapping-key dev

输出：

{
    "ApiId": "a1b2c3d4",
    "ApiMappingId": "0qzs2sy7bh",
    "ApiMappingKey": "dev"
    "Stage": "dev"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

为 HTTP API 启用 CORS

以下 update-api 示例更新指定 API 的 CORS 配置，以允许来自 https://www.example.com 的请求。

aws apigatewayv2 update-api \
    --api-id a1b2c3d4 \
    --cors-configuration AllowOrigins=https://www.example.com

输出：

{
    "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"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的为 HTTP API 配置 CORS。

更新授权方

以下 update-authorizer 示例将 JWT 授权方的身份源更改为名为 Authorization 的标头。

aws apigatewayv2 update-authorizer \
    --api-id a1b2c3d4 \
    --authorizer-id a1b2c3 \
    --identity-source '$request.header.Authorization'

输出：

{
    "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"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 JWT 授权方控制对 HTTP API 的访问。

更改部署的说明

以下 update-deployment 示例更新部署的说明。

aws apigatewayv2 update-deployment \
    --api-id a1b2c3d4 \
    --deployment-id abcdef \
    --description 'Manual deployment to fix integration test failures.'

输出：

{
    "AutoDeployed": false,
    "CreatedDate": "2020-02-05T16:21:48+00:00",
    "DeploymentId": "abcdef",
    "DeploymentStatus": "DEPLOYED",
    "Description": "Manual deployment to fix integration test failures."
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中开发 HTTP API。

更新自定义域名

以下 update-domain-name 示例为 api.example.com 自定义域名指定新的 ACM 证书。

aws apigatewayv2 update-domain-name \
    --domain-name api.example.com \
    --domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678

输出：

{
    "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"
        }
    ]
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的在 API Gateway 中设置区域自定义域名。

更新 Lambda 集成

以下 update-integration 示例将现有 AWS Lambda 集成更新为使用指定的 Lambda 函数。

aws apigatewayv2 update-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3 \
    --integration-uri arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations

输出：

{
    "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
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的为 HTTP API 配置集成和设置 WebSocket API 集成。

示例 1：更新路由的集成

以下 update-route 示例更新指定路由的集成。

aws apigatewayv2 update-route \
    --api-id a1b2c3d4 \
    --route-id a1b2c3 \
    --target integrations/a1b2c6

输出：

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteId": "a1b2c3",
    "RouteKey": "ANY /pets",
    "Target": "integrations/a1b2c6"
}

示例 2：向路由添加授权方

以下 update-route 示例将指定路由更新为使用 JWT 授权方。

aws apigatewayv2 update-route \
    --api-id a1b2c3d4  \
    --route-id a1b2c3  \
    --authorization-type JWT \
    --authorizer-id a1b2c5 \
    --authorization-scopes user.id user.email

输出：

{
    "ApiKeyRequired": false,
    "AuthorizationScopes": [
        "user.id",
        "user.email"
    ],
    "AuthorizationType": "JWT",
    "AuthorizerId": "a1b2c5",
    "OperationName": "GET HTTP",
    "RequestParameters": {},
    "RouteId": "a1b2c3",
    "RouteKey": "GET /pets",
    "Target": "integrations/a1b2c6"
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 JWT 授权方控制对 HTTP API 的访问。

配置自定义节流

以下 update-stage 示例为 API 的指定阶段和路由配置自定义节流。

aws apigatewayv2 update-stage \
    --api-id a1b2c3d4 \
    --stage-name dev \
    --route-settings '{"GET /pets":{"ThrottlingBurstLimit":100,"ThrottlingRateLimit":2000}}'

输出：

{
    "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": {}
}

有关更多信息，请参阅《Amazon API Gateway 开发人员指南》中的保护 HTTP API。

更新 VPC 链接

以下 update-vpc-link 示例更新 VPC 链接的名称。创建 VPC 链接后，您无法更改其安全组或子网。

aws apigatewayv2 update-vpc-link \
    --vpc-link-id abcd123 \
    --name MyUpdatedVpcLink

输出：

{
    "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"
}

要了解更多信息，请参阅《Amazon API Gateway 开发人员指南》中的使用 HTTP API 的 VPC 链接。