slb template dns response-rate-limiting¶
DNS Response Rate Limiting
response-rate-limiting Specification¶
Parameter Value Type Configuration Resource Element Name response-rate-limiting Element URI /axapi/v3/slb/template/dns/{name}/response-rate-limiting Element Attributes response-rate-limiting_attributes Partition Visibility shared Schema response-rate-limiting schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/template/dns/{name}/response-rate-limiting | ||
Get Object | GET | /axapi/v3/slb/template/dns/{name}/response-rate-limiting | ||
Modify Object | POST | /axapi/v3/slb/template/dns/{name}/response-rate-limiting | ||
Replace Object | PUT | /axapi/v3/slb/template/dns/{name}/response-rate-limiting | ||
Delete Object | DELETE | /axapi/v3/slb/template/dns/{name}/response-rate-limiting |
response-rate-limiting attributes¶
TC-rate
Description Every n’th response that would be rate-limited will respond with TC bit
Type: number
Range: 2-10
Mutual Exclusion: TC-rate and slip-rate are mutually exclusive
action
Description ‘log-only’: Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; ‘rate-limit’: Rate-Limit based on configuration (Default); ‘whitelist’: Whitelist, disable rate-limiting;
Type: string
Supported Values: log-only, rate-limit, whitelist
Default: rate-limit
enable-log
Description Enable logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
filter-response-rate
Description Maximum allowed request rate for the filter. This should match average traffic. (default 10 per seconds)
Type: number
Range: 1-1000
Default: 10
match-subnet
Description IP subnet mask (response rate by IP subnet mask)
Type: string
Format: ipv4-netmask
Default: 255.255.255.255
match-subnet-v6
Description IPV6 subnet mask (response rate by IPv6 subnet mask)
Type: number
Range: 1-128
Default: 128
response-rate
Description Responses exceeding this rate within the window will be dropped (default 5 per second)
Type: number
Range: 1-1000
Default: 5
rrl-class-list-list
Type: List
Reference Object: /axapi/v3/slb/template/dns/{name}/response-rate-limiting/rrl-class-list/{name}
slip-rate
Description Every n’th response that would be rate-limited will be let through instead
Type: number
Range: 2-10
Mutual Exclusion: slip-rate and TC-rate are mutually exclusive
src-ip-only
Description
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
window
Description Rate-Limiting Interval in Seconds (default is one)
Type: number
Range: 1-60
Default: 1
rrl-class-list-list¶
Specification Value Type list Block object keys lid-list
Type: List
Reference Object: /axapi/v3/slb/template/dns/{name}/response-rate-limiting/rrl-class-list/{name}/lid/{lidnum}
name
Description Class-list name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
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
rrl-class-list-list_lid-list¶
Specification Value Type list Block object keys lid-action
Description ‘log-only’: Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; ‘rate-limit’: Rate-Limit based on configuration (Default); ‘whitelist’: Whitelist, disable rate-limiting;
Type: string
Supported Values: log-only, rate-limit, whitelist
Default: rate-limit
lid-enable-log
Description Enable logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
lid-match-subnet
Description IP subnet mask (response rate by IP subnet mask)
Type: string
Format: ipv4-netmask
Default: 255.255.255.255
lid-match-subnet-v6
Description IPV6 subnet mask (response rate by IPv6 subnet mask)
Type: number
Range: 1-128
Default: 128
lid-response-rate
Description Responses exceeding this rate within the window will be dropped (default 5 per second)
Type: number
Range: 1-1000
Default: 5
lid-slip-rate
Description Every n’th response that would be rate-limited will be let through instead
Type: number
Range: 2-10
Mutual Exclusion: lid-slip-rate and lid-tc-rate are mutually exclusive
lid-src-ip-only
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
lid-tc-rate
Description Every n’th response that would be rate-limited will respond with TC bit
Type: number
Range: 2-10
Mutual Exclusion: lid-tc-rate and lid-slip-rate are mutually exclusive
lid-window
Description Rate-Limiting Interval in Seconds (default is one)
Type: number
Range: 1-60
Default: 1
lidnum
Description Specify a limit ID
Type: number
Range: 1-1023
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