template limit-policy limit-pps¶
Enable Packets Per Second Rate Limit
limit-pps Specification¶
Parameter Value Type Configuration Resource Element Name limit-pps Element URI /axapi/v3/template/limit-policy/{policy-number}/limit-pps Element Attributes limit-pps_attributes Partition Visibility shared Schema limit-pps schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/template/limit-policy/{policy-number}/limit-pps | ||
Get Object | GET | /axapi/v3/template/limit-policy/{policy-number}/limit-pps | ||
Modify Object | POST | /axapi/v3/template/limit-policy/{policy-number}/limit-pps | ||
Replace Object | PUT | /axapi/v3/template/limit-policy/{policy-number}/limit-pps | ||
Delete Object | DELETE | /axapi/v3/template/limit-policy/{policy-number}/limit-pps |
limit-pps attributes¶
ddos-protection-factor
Description Enable DDoS Protection (Multiplier of the downlink PPS)
Type: number
Range: 1-50
downlink
Description Downlink PPS limit (Number of Packets per second)
Type: number
Range: 1-2147483647
downlink-burstsize
Description PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)
Type: number
Range: 1-2147483647
downlink-relaxed
Description Relax the limitation when the policy has more tokens from the parent of policy
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
total
Description Total PPS limit (Number of Packets per second)
Type: number
Range: 1-2147483647
total-burstsize
Description PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)
Type: number
Range: 1-2147483647
total-relaxed
Description Relax the limitation when the policy has more tokens from the parent of policy
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uplink
Description Uplink PPS limit (Number of Packets per second)
Type: number
Range: 1-2147483647
uplink-burstsize
Description PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets)
Type: number
Range: 1-2147483647
uplink-relaxed
Description Relax the limitation when the policy has more tokens from the parent of policy
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters