AWS::ApiGateway::UsagePlan QuotaSettings - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::ApiGateway::UsagePlan QuotaSettings

QuotaSettingsAWS::ApiGateway::UsagePlan 资源的属性,用于指定用户可对您的 REST API 发出的最大请求数。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Limit" : Integer, "Offset" : Integer, "Period" : String }

YAML

Limit: Integer Offset: Integer Period: String

属性

Limit

用户可在指定时间段内发出的最大请求数。

必需:否

类型:整数

Update requires: No interruption

Offset

对于初始时间段,要从指定限制中减去的请求数。当您首次实施使用计划时,该计划可能在周或月的中段开始。利用此属性,您可降低此初始时间段的限制。

必需:否

类型:整数

Update requires: No interruption

Period

最大请求限制适用的时间段,如 DAYWEEK。有关有效值的信息,请参阅 Amazon API Gateway REST API 参考中的 UsagePlan 资源的周期属性。

必需:否

类型:字符串

Update requires: No interruption

另请参阅

  • Amazon API Gateway REST API 参考中的 UsagePlan