fw rate-limit

View Rate Limit Entries

rate-limit Specification

Parameter	Value
Type	Configuration Resource
Element Name	rate-limit
Element URI	/axapi/v3/fw/rate-limit
Element Attributes	rate-limit_attributes
Partition Visibility	shared
Statistics Data URI	/axapi/v3/fw/rate-limit/stats
Operational Data URI	/axapi/v3/fw/rate-limit/oper
Schema	rate-limit schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/fw/rate-limit	rate-limit attributes
Get Object	GET	/axapi/v3/fw/rate-limit	rate-limit attributes
Modify Object	POST	/axapi/v3/fw/rate-limit	rate-limit attributes
Replace Object	PUT	/axapi/v3/fw/rate-limit	rate-limit attributes
Delete Object	DELETE	/axapi/v3/fw/rate-limit	rate-limit attributes

rate-limit attributes

interval

Description ‘100’: 100 ms; ‘250’: 250 ms; ‘500’: 500 ms; ‘1000’: 1000 ms;

Type: string

Supported Values: 100, 250, 500, 1000

Default: 1000

sampling-enable

Type: List

summary

Description: summary is a JSON Block. Please see below for summary

Type: Object

Reference Object: /axapi/v3/fw/rate-limit/summary

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sampling-enable

Specification	Value
Type	list
Block object keys

counters1

Description ‘all’: all; ‘ratelimit_used_total_mem’: Total Memory Used For Rate-limiting (bytes); ‘ratelimit_used_spm_mem’: Total SPM Memory Used For Rate-limiting Infra in Bytes; ‘ratelimit_used_heap_mem’: Total Heap Memory Used For Rate-limiting Infra in Bytes; ‘ratelimit_entry_alloc_frm_spm_mem’: Total Number of Rate-limit Entries created using SPM Memory; ‘ratelimit_high_accurate_entry_alloc_fail’: Total Number of Failures to Create Highly Accurate Rate-limit Entries Due to Memory Allocation Failures; ‘ratelimit_high_perf_entry_alloc_fail’: Total Number of Failures to Create High-Perf Rate-limit Entries Due to Memory Allocation Failures; ‘ratelimit_high_perf_entry_secondary_alloc_fail’: Total Number of Failures to Allocate Additional Memory to Existing High-Perf Rate-limit Entries; ‘ratelimit_entry_alloc_fail_rate_too_high’: Total Number of Attempts to Configure Too High Rate Limits; ‘ratelimit_entry_alloc_fail_metric_count_gt_supported’: Total Number of Failures to Create High-Perf Rate-limit Entries Because of Too Many Metrics; ‘ratelimit_entry_count_t2_key’: Number of Total Rate-limit Entries; ‘ratelimit_entry_count_fw_rule_uid’: Number of Rate-limit Entries with Scope Aggregate; ‘ratelimit_entry_count_ip_addr’: Number of Rate-limit Entries with Scope IPv4 Address; ‘ratelimit_entry_count_ip6_addr’: Number of Rate-limit Entries with Scope IPv6 Address; ‘ratelimit_entry_count_session_id’: Number of Rate-limit Entries with Scope Session ID; ‘ratelimit_entry_count_rule_ipv4_prefix’: Number of Rate-limit Entries with Scope IPv4 Prefix; ‘ratelimit_entry_count_rule_ipv6_prefix’: Number of Rate-limit Entries with Scope IPv6 Prefix; ‘ratelimit_entry_count_parent_uid’: Number of Parent Rate-limit Entries with Scope Aggregate; ‘ratelimit_entry_count_parent_ipv4_prefix’: Number of Parent Rate-limit Entries with Scope IPv4 Prefix; ‘ratelimit_entry_count_parent_ipv6_prefix’: Number of Parent Rate-limit Entries with Scope IPv6 Prefix; ‘ratelimit_infra_generic_errors’: Current Number of Generic Errors Encountered in Ratelimit Infra;

Type: string

Supported Values: all, ratelimit_used_total_mem, ratelimit_used_spm_mem, ratelimit_used_heap_mem, ratelimit_entry_alloc_frm_spm_mem, ratelimit_high_accurate_entry_alloc_fail, ratelimit_high_perf_entry_alloc_fail, ratelimit_high_perf_entry_secondary_alloc_fail, ratelimit_entry_alloc_fail_rate_too_high, ratelimit_entry_alloc_fail_metric_count_gt_supported, ratelimit_entry_count_t2_key, ratelimit_entry_count_fw_rule_uid, ratelimit_entry_count_ip_addr, ratelimit_entry_count_ip6_addr, ratelimit_entry_count_session_id, ratelimit_entry_count_rule_ipv4_prefix, ratelimit_entry_count_rule_ipv6_prefix, ratelimit_entry_count_parent_uid, ratelimit_entry_count_parent_ipv4_prefix, ratelimit_entry_count_parent_ipv6_prefix, ratelimit_infra_generic_errors

summary

Specification	Value
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters