template limit-policy¶
Create a Limit Policy
limit-policy Specification¶
Parameter Value 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 Partition Visibility shared 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¶
limit-concurrent-sessions
Description Enable Concurrent Session Limit (Number of Concurrent Sessions)
Type: number
Range: 1-2147483647
limit-cps
Description: limit-cps is a JSON Block. Please see below for limit-cps
Type: Object
Reference Object: /axapi/v3/template/limit-policy/{policy-number}/limit-cps
limit-pps
Description: limit-pps is a JSON Block. Please see below for limit-pps
Type: Object
Reference Object: /axapi/v3/template/limit-policy/{policy-number}/limit-pps
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
limit-throughput
Description: limit-throughput is a JSON Block. Please see below for limit-throughput
Type: Object
Reference Object: /axapi/v3/template/limit-policy/{policy-number}/limit-throughput
log
Description Log when Session Limit is exceeded
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
max-min-fair
Description Enable max-min-fairness
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
parent
Description Specify the parent of limit-policy
Type: number
Range: 1-1023
policy-number
Description Limit Policy Number
Type: number
Range: 1-1023
prefix-length
Description Prefix length
Type: number
Range: 1-128
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
limit-throughput¶
Specification Value Type object downlink
Description Downlink Throughput limit (Mega Bits per second)
Type: number
Range: 1-100000
downlink-burstsize
Description Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)
Type: number
Range: 1-100000
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 Throughput limit (Mega Bits per second)
Type: number
Range: 1-100000
total-burstsize
Description Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)
Type: number
Range: 1-100000
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
unit
Description ‘Mbps’: default; ‘Kbps’: minimum configurable limit is 100 Kbps;
Type: string
Supported Values: Mbps, Kbps
Default: Mbps
uplink
Description Uplink Throughput limit (Mega Bits per second)
Type: number
Range: 1-100000
uplink-burstsize
Description Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second)
Type: number
Range: 1-100000
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
limit-cps¶
Specification Value Type object burstsize
Description CPS Token Bucket Size (Must Exceed Configured Rate) (In Connections per second)
Type: number
Range: 1-2147483647
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
value
Description Connections Per Second Rate Limit (Number of Connections per second)
Type: number
Range: 1-2147483647
limit-pps¶
Specification Value Type object 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