template limit-policy¶
Create a Limit Policy
limit-policy Specification¶
Type Collection Object Key(s) policy-number Collection Name limit-policy-list Collection URI /axapi/v3/template/limit-policy Element Name limit-policy Element URI /axapi/v3/template/limit-policy/{policy-number} Element Attributes limit-policy_attributes Schema limit-policy schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/template/limit-policy | ||
Create List | POST | /axapi/v3/template/limit-policy | ||
Get Object | GET | /axapi/v3/template/limit-policy/{policy-number} | ||
Get List | GET | /axapi/v3/template/limit-policy | ||
Modify Object | POST | /axapi/v3/template/limit-policy/{policy-number} | ||
Replace Object | PUT | /axapi/v3/template/limit-policy/{policy-number} | ||
Replace List | PUT | /axapi/v3/template/limit-policy | ||
Delete Object | DELETE | /axapi/v3/template/limit-policy/{policy-number} |
limit-policy-list¶
limit-policy-list is JSON List of limit-policy attributes
limit-policy-list : [
]
limit-policy attributes¶
ddos-protection-factor
Description Enable DDoS Protection (Multiplier of the downlink PPS)
Type: number
Range: 1-50
downlink-pps
Description Downlink PPS limit (Number of Packets per second)
Type: number
Range: 1-2147483647
downlink-throughput
Description Downlink Throughput limit (Mega Bits per second)
Type: number
Range: 1-100000
limit-concurrent-sessions
Description Enable Concurrent Session Limit (Number of Concurrent Sessions)
Type: number
Range: 1-2147483647
limit-cps
Description Enable Connections Per Second Rate Limit (Number of Connections per second)
Type: number
Range: 1-2147483647
limit-rate
Description ‘limit-pps’: Enable Packets Per Second Rate Limit; ‘limit-throughput’: Enable Throughput Rate Limit;
Type: string
Supported Values: limit-pps, limit-throughput
limit-scope
Description ‘aggregate’: Rule Level; ‘subscriber-ip’: Subscriber IP Level; ‘subscriber-prefix’: Subscriber Prefix Level;
Type: string
Supported Values: aggregate, subscriber-ip, subscriber-prefix
Default: subscriber-ip
log
Description Log when Session Limit is exceeded
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
policy-number
Description Limit Policy Number
Type: number
Range: 1-1023
prefix-length
Description Prefix length
Type: number
Range: 1-128
total-pps
Description Total PPS limit (Number of Packets per second)
Type: number
Range: 1-2147483647
total-throughput
Description Total Throughput limit (Mega Bits per second)
Type: number
Range: 1-100000
uplink-pps
Description Uplink PPS limit (Number of Packets per second)
Type: number
Range: 1-2147483647
uplink-throughput
Description Uplink Throughput limit (Mega Bits per second)
Type: number
Range: 1-100000
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters