Help Center/ API Gateway/ User Guide/ Managing APIs/ API Design File Extension Definitions/ x-apigateway-ratelimits
Updated on 2024-11-27 GMT+08:00
View PDF
Share

x-apigateway-ratelimits

Meaning: Mapping between a request throttling policy name and limit values.

Scope of effect: Swagger Object

Example:

x-apigateway-ratelimits:
  customRatelimitName:
    api-limit: 200
    app-limit: 200
    user-limit: 200
    ip-limit: 200
    interval: 1
    unit: second/minute/hour
    shared: true
    special: 
      - type: APP
        limit: 100
        instance: xxxxxxxxx
Table 1 Parameter description

Parameter

Mandatory

Type

Description

customRatelimitName

No

x-apigateway-ratelimits.policy

Name of a request throttling policy.

To use the policy, set x-apigateway-ratelimit to the policy name.