Amazon EventBridge 中规则的 Amazon API Gateway 目标
您可以使用 Amazon API Gateway 创建、发布、维护和监控 API。Amazon EventBridge 支持向 API Gateway 端点发送事件。当您将 API Gateway 端点指定为目标时,发送到该目标的每个事件都将映射一个发送到该端点的请求。
重要
EventBridge 支持使用 API Gateway 边缘优化和区域端点作为目标。目前不支持私有端点。要了解端点的更多信息,请参阅 https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-endpoint-types.html。
可以将 API Gateway 目标用于以下使用场景:
-
根据 AWS 或第三方事件,调用托管在 API Gateway 中的客户指定 API。
-
按计划定期调用端点。
EventBridge JSON 事件信息作为 HTTP 请求的正文发送到您的端点。您可以在目标的 HttpParameters 字段中指定其他请求属性,如下所示:
-
PathParameterValues列出了与您的端点 ARN 中的任何路径变量顺序对应的值,例如"arn:aws:execute-api:us-east-1:112233445566:myapi/dev/POST/pets/*/*"。 -
QueryStringParameters表示 EventBridge 附加到被调用端点的查询字符串参数。 -
HeaderParameters定义要添加到请求中的 HTTP 标头。
注意
出于安全考虑,不允许使用以下 HTTP 标头密钥:
-
任何以
X-Amz或X-Amzn为前缀的标头密钥 -
Authorization -
Connection -
Content-Encoding -
Content-Length -
Host -
Max-Forwards -
TE -
Transfer-Encoding -
Trailer -
Upgrade -
Via -
WWW-Authenticate -
X-Forwarded-For
动态参数
在调用 API Gateway 目标时,您可以向发送到目标的事件动态添加数据。有关更多信息,请参阅 目标参数。
调用重试
对于所有目标,EventBridge 都会重试一些失败的调用。对于 API Gateway,EventBridge 会重试以 5xx 或 429 HTTP 状态码发送的响应,时长达 24 小时,并采用指数级退避和抖动FailedInvocations 指标。EventBridge 不会重试其他 4xx HTTP 错误。
超时
EventBridge 规则 API Gateway 请求的客户端执行超时上限必须为 5 秒。如果 API Gateway 的响应时间超过 5 秒,EventBridge 会将该请求设为超时,然后重试。
EventBridge 管道 API Gateway 请求的超时上限为 29 秒,这是 API Gateway 的上限。