forked from docs/doc-exports
Chen, Junjie
324aa7d3c4
Reviewed-by: Mützel, Andrea <andrea.muetzel@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
10 KiB
10 KiB
x-apigateway-ratelimits.policy
Meaning: Definition of a request throttling policy.
Scope of effect: x-apigateway-ratelimits
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: xxxxxxx
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
api-limit |
Yes |
Number |
Maximum number of times an API can be called. |
user-limit |
No |
Number |
Maximum number of times the API can be called by a user. |
app-limit |
No |
Number |
Maximum number of times the API can be called by an app. |
ip-limit |
No |
Number |
Maximum number of times the API can be called by an IP address. |
interval |
Yes |
Number |
Throttling period. |
unit |
Yes |
String |
Throttling unit, which can be SECOND, MINUTE, HOUR, or DAY. |
shared |
No |
Boolean |
Whether to share the throttling limits among APIs. |
special |
No |
x-apigateway-ratelimits.policy.special Array |
Special request throttling policy. |
Parent topic: Extended Definition