Help Center/ API Gateway/ Developer Guide/ Importing and Exporting APIs/ Extended Definition/ x-apigateway-ratelimits/ x-apigateway-ratelimits.policy.special
Updated on 2023-04-06 GMT+08:00
View PDF

x-apigateway-ratelimits.policy.special

Meaning: Definition of a special request throttling policy.

Scope of effect: x-apigateway-ratelimits.policy

Example:

x-apigateway-ratelimits:
  customRatelimitName:
    api-limit: 200
    app-limit: 200
    user-limit: 200
    ip-limit: 200
    interval: 1
    unit: MINUTE
    shared: false
    special: 
      - type: USER
        limit: 100
        instance: xxxxxxxx
Table 1 Parameter description

Parameter

Mandatory

Type

Description

type

Yes

String

Special request throttling policy type, which can be APP or USER.

limit

Yes

Number

Access limit.

instance

Yes

String

ID of an excluded app or user.
Parent topic: x-apigateway-ratelimits