ddos dns-cache¶
DNS Cache Settings
dns-cache Specification¶
Type
Collection
Object Key(s)
name
Collection Name
Collection URI
/axapi/v3/ddos/dns-cache
Element Name
dns-cache
Element URI
/axapi/v3/ddos/dns-cache/{name}
Element Attributes
dns-cache_attributes
Statistics Data URI
/axapi/v3/ddos/dns-cache/{name}/stats
Operational Data URI
/axapi/v3/ddos/dns-cache/{name}/oper
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/ddos/dns-cache | ||
Create List | POST | /axapi/v3/ddos/dns-cache | ||
Get Object | GET | /axapi/v3/ddos/dns-cache/{name} | ||
Get List | GET | /axapi/v3/ddos/dns-cache | ||
Modify Object | POST | /axapi/v3/ddos/dns-cache/{name} | ||
Replace Object | PUT | /axapi/v3/ddos/dns-cache/{name} | ||
Replace List | PUT | /axapi/v3/ddos/dns-cache | ||
Delete Object | DELETE | /axapi/v3/ddos/dns-cache/{name} |
dns-cache-list¶
dns-cache-list is JSON List of dns-cache attributes
dns-cache-list : [
]
dns-cache attributes¶
any-query-action-str
Description ‘respond-refuse’: Send refuse response (default); ‘respond-empty’: Send empty response; ‘drop’: Drop the request;
Type: string
Supported Values: respond-refuse, respond-empty, drop
Default: respond-refuse
default-serving-action
Description ‘serve-from-cache’: Serve DNS records; ‘forward’: Forward to DNS server; ‘drop’: Drop the request;
Type: string
Supported Values: serve-from-cache, forward, drop
Default: serve-from-cache
domain-group
Description: domain-group is a JSON Block. Please see below for domain-group
Type: Object
Refernce Object: /axapi/v3/ddos/dns-cache/{name}/domain-group
fqdn-manual-override-action-list
Type: List
Refernce Object: /axapi/v3/ddos/dns-cache/{name}/fqdn-manual-override-action/{fqdn-name}
name
Description DNS Cache Instance Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
neg-cache-action-follow-q-rate
Description Negative cached response queries counted toward query-rate-threshold
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
non-authoritative-zone-query-action-str
Description ‘default’: Default action: respond-refuse; ‘forward’: Forward to DNS server; ‘respond-refuse’: Send refuse response; ‘drop’: Drop the request;
Type: string
Supported Values: default, forward, respond-refuse, drop
Default: respond-refuse
sharded-domain-group-list
Type: List
Refernce Object: /axapi/v3/ddos/dns-cache/{name}/sharded-domain-group/{name}
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
zone-domain-lookup-miss-action
Description ‘respond-nxdomain’: Send NxDomain response; ‘drop’: Drop the request;
Type: string
Supported Values: respond-nxdomain, drop
Default: respond-nxdomain
zone-manual-override-action-list
Type: List
Refernce Object: /axapi/v3/ddos/dns-cache/{name}/zone-manual-override-action/{zone-name}
zone-transfer
Description: zone-transfer is a JSON Block. Please see below for zone-transfer
Type: Object
Refernce Object: /axapi/v3/ddos/dns-cache/{name}/zone-transfer
domain-group¶
Specification
Type
object
domain-list-policy-list
Type: List
Refernce Object: /axapi/v3/ddos/dns-cache/{name}/domain-group/domain-list-policy/{name}
name
Description DNS domain group
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
domain-group_domain-list-policy-list¶
Specification
Type
list
Block object keys
cache-all-records
Description cache all fqdn records including uncommon types
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
client-ipv4
Description Client ipv4 address
Type: string
Format: ipv4-address
client-ipv6
Description Client ipv6 address
Type: string
Format: ipv6-address
force
Description Force update even the serial is the same
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
manual-refresh
Description Manually refresh the particular zone
Type: string
Format: string-rlx
Maximum Length: 253 characters
Maximum Length: 1 characters
name
Description DNS domain list policy
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
oversize-answer-response
Description ‘set-truncate-bit’: Set the TC bit for oversize answer(default); ‘disable-truncate-bit’: Do not set TC bit for oversize answer;
Type: string
Supported Values: set-truncate-bit, disable-truncate-bit
Default: set-truncate-bit
refresh-interval-hours
Description Zone transfer refresh rate in hours (Default 4). 0 means no refresh
Type: number
Range: 0-24
Default: 4
resolve-cname-record
Description Always try to resolve domain in CNAME record answer section
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
respond-with-authority
Description Respond with authority section for all requests under this list
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-ipv4
Description Master ipv4 address
Type: string
Format: ipv4-address
server-ipv6
Description Master ipv6 address
Type: string
Format: ipv6-address
server-v4-port
Description Port number (default 53)
Type: number
Range: 1-65535
Default: 53
server-v6-port
Description Port number (default 53)
Type: number
Range: 1-65535
Default: 53
ttl-override
Description Override the TTL value for zone transfer
Type: number
Range: 1-2147483647
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
fqdn-manual-override-action-list¶
Specification
Type
list
Block object keys
action
Description ‘default’: Default; ‘forward’: Forward to DNS server; ‘drop’: Drop the request; ‘serve-from-cache’: Serve DNS records;
Type: string
Supported Values: default, forward, drop, serve-from-cache
fqdn-name
Description Specify fqdn name
Type: string
Format: string-rlx
Maximum Length: 253 characters
Maximum Length: 1 characters
zone-transfer¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
zone-manual-override-action-list¶
Specification
Type
list
Block object keys
action
Description ‘default’: Default; ‘forward’: Forward to DNS server; ‘drop’: Drop the request; ‘serve-from-cache’: Serve DNS records;
Type: string
Supported Values: default, forward, drop, serve-from-cache
zone-name
Description Specify zone name
Type: string
Format: string-rlx
Maximum Length: 253 characters
Maximum Length: 1 characters
stats data¶
Counter |
Size |
Description |
|
|---|---|---|---|
fqdn-aaaa |
8 |
fqdn-aaaa |
|
fqdn-a |
8 |
fqdn-a |
|
fqdn-delegation |
8 |
fqdn-delegation |
|
fqdn-mx |
8 |
fqdn-mx |
|
total-cached-fqdn |
8 |
total-cached-fqdn |
|
fqdn-srv |
8 |
fqdn-srv |
|
fqdn-ns |
8 |
fqdn-ns |
|
shard-size |
8 |
shard-size |
|
fqdn-cname |
8 |
fqdn-cname |
|
fqdn-txt |
8 |
fqdn-txt |
|
fqdn-wildcard |
8 |
fqdn-wildcard |
|
total-cached-records |
8 |
total-cached-records |
|
resp-ext-size |
8 |
resp-ext-size |
|
fqdn-other |
8 |
fqdn-other |
|
fqdn-ptr |
8 |
fqdn-ptr |
|
fqdn-soa |
8 |
fqdn-soa |
operational data¶
Counter |
Size |
Description |
|
|---|---|---|---|
domain-entries |
domain-entries |
||
record-type |
string |
record-type |
|
answer-section-size |
number |
Answer section size |
|
authoritative-section |
authoritative-section |
||
additional-section |
additional-section |
||
additional-section-record-count |
number |
Additional section record Count |
|
answer-section |
answer-section |
||
response-flag |
string |
response flag |
|
additional-section-size |
number |
Additional section size |
|
debug-mode |
flag |
debug-mode |
|
all-cached-fqdn |
flag |
all-cached-fqdn |
|
authority-section-record-count |
number |
Authority section record Count |
|
response-status |
string |
response status |
|
authority-section-size |
number |
Autority section size |
|
cached-fqdn-name |
string-rlx |
cached-fqdn-name |
|
answer-section-record-count |
number |
Answer section record Count |