ApiUsagePlan - AWS Serverless Application Model
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ApiUsagePlan

为 API 网关 API 配置使用计划。有关使用计划的更多信息,请参阅 https://docs.amazonaws.cn/apigateway/latest/developerguide/api-gateway-api-usage-plans.html 中的创建和使用带 API 密钥的使用计划API 网关 开发人员指南。

语法

在您的 中声明此实体 AWS 无服务器应用程序模型 (AWS SAM) 模板时,请使用以下语法。

属性

CreateUsagePlan

确定如何配置此使用计划。有效值包括 PER_APISHAREDNONE

PER_API 创建特定于此 API 的 AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKeyAWS::ApiGateway::UsagePlanKey 资源。这些资源分别具有 IDs、<api-logical-id>UsagePlan<api-logical-id>ApiKey 的逻辑 <api-logical-id>UsagePlanKey

SHARED 创建 AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKeyAWS::ApiGateway::UsagePlanKey 资源,这些资源在同一 CreateUsagePlan: SHARED 模板中也具有 AWS SAM 的任何 API 之间共享。这些资源分别具有 IDs、ServerlessUsagePlanServerlessApiKey 的逻辑 ServerlessUsagePlanKey。如果您使用此选项,我们建议您仅在一个 API 资源上为此使用计划添加其他配置,以避免冲突定义和不确定的状态。

NONE 禁止使用此 API 创建或关联使用计划。这仅在 SHARED 中指定了 PER_API的Globals部分 AWS SAM 模板 时是必需的。

有效值PER_APISHAREDNONE

类型: 字符串

必需: 是

兼容性AWS CloudFormation: 此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。

Description

使用计划的描述。

类型: 字符串

必需: 否

兼容性AWS CloudFormation: 此属性直接传递给 Description 资源的 AWS::ApiGateway::UsagePlan 属性。

Quota

配置用户可在指定时间间隔内发出的请求的数量。

类型: QuotaSettings

必需: 否

兼容性AWS CloudFormation: 此属性直接传递给 Quota 资源的 AWS::ApiGateway::UsagePlan 属性。

Tags

与使用计划关联的任意标签(键值对)的数组。

此属性使用 CloudFormation 标签类型

类型:列表

必需: 否

兼容性AWS CloudFormation: 此属性直接传递给 Tags 资源的 AWS::ApiGateway::UsagePlan 属性。

Throttle

配置整体请求速率(每秒平均请求数)和突发容量。

类型: ThrottleSettings

必需: 否

兼容性AWS CloudFormation: 此属性直接传递给 Throttle 资源的 AWS::ApiGateway::UsagePlan 属性。

UsagePlanName

使用计划的名称。

类型: 字符串

必需: 否

兼容性AWS CloudFormation: 此属性直接传递给 UsagePlanName 资源的 AWS::ApiGateway::UsagePlan 属性。

示例

UsagePlan

以下是使用计划示例。

YAML

Auth: UsagePlan: CreateUsagePlan: PER_API Description: Usage plan for this API Quota: Limit: 500 Period: MONTH Throttle: BurstLimit: 100 RateLimit: 50 Tags: - Key: TagName Value: TagValue