slb template dns-logging¶

DNS Logging template

dns-logging Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name dns-logging-list

Collection URI /axapi/v3/slb/template/dns-logging

Element Name dns-logging

Element URI /axapi/v3/slb/template/dns-logging/{name}

Element Attributes dns-logging_attributes

Partition Visibility shared

Schema dns-logging schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/slb/template/dns-logging	dns-logging attributes
POST /axapi/v3/slb/template/dns-logging/ Payload: { "dns-logging": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/slb/template/dns-logging	dns-logging attributes
Get Object	GET	/axapi/v3/slb/template/dns-logging/{name}	dns-logging attributes
GET /axapi/v3/slb/template/dns-logging/a Reponse: { "dns-logging": { "name": "a", "disable": 0, "uuid": "18b00f3e-5072-11ee-98ee-fbe362803b33", "user-tag": "a", "a10-url": "/axapi/v3/slb/template/dns-logging/a" } }
Get List	GET	/axapi/v3/slb/template/dns-logging	dns-logging-list
Modify Object	POST	/axapi/v3/slb/template/dns-logging/{name}	dns-logging attributes
Replace Object	PUT	/axapi/v3/slb/template/dns-logging/{name}	dns-logging attributes
PUT /axapi/v3/slb/template/dns-logging/a Payload: { "dns-logging": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/slb/template/dns-logging	dns-logging-list
Delete Object	DELETE	/axapi/v3/slb/template/dns-logging/{name}	dns-logging attributes
DELETE /axapi/v3/slb/template/dns-logging/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

dns-logging-list¶

dns-logging-list is JSON List of dns-logging attributes

dns-logging-list : [

{ dns-logging attributes },

{ dns-logging attributes },

…

]

dns-logging attributes¶

disable

Description Disable DNS Logging template

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-logging-protocol

Description ‘both’: Log DNS over tcp and udp; ‘tcp’: Log DNS over tcp; ‘udp’: Log DNS over udp;

Type: string

Supported Values: both, tcp, udp

dns-logging-request-section

Description ‘all’: Log DNS header and question section; ‘header’: Log DNS header information; ‘question’: Log DNS question section;

Type: string

Supported Values: all, header, question

dns-logging-response-section

Description ‘all’: Log DNS header information, answer, authority, additional section content; ‘header’: Log DNS header information; ‘answer’: Log DNS header information and answer section content;

Type: string

Supported Values: all, header, answer

dns-logging-type

Description ‘query’: DNS Query Logging; ‘response’: DNS Response Logging; ‘both’: DNS Query and Response Logging;

Type: string

Supported Values: query, response, both

name

Description DNS Logging Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

response-type

Description: response-type is a JSON Block. Please see below for response-type

Type: Object

Reference Object: /axapi/v3/slb/template/dns-logging/{name}/response-type

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

response-type¶

Specification Value

Type object

config

Description start config the response type detail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

type-list

Type: List

Reference Object: /axapi/v3/slb/template/dns-logging/{name}/response-type/type/{response-type-name}

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

response-type_type-list¶

Specification Value

Type list

Block object keys

caa-type-limit-num

Description Limit the field length

Type: number

Range: 0-256

Default: 0

Mutual Exclusion: caa-type-limit-num and caa-type-no-limit are mutually exclusive

caa-type-no-limit

Description Print the field as much as possible

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: caa-type-no-limit and caa-type-limit-num are mutually exclusive

digest

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dnskey-type-limit-num

Description Limit the field length

Type: number

Range: 0-256

Default: 0

Mutual Exclusion: dnskey-type-limit-num and dnskey-type-no-limit are mutually exclusive

dnskey-type-no-limit

Description Print the field as much as possible

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: dnskey-type-no-limit and dnskey-type-limit-num are mutually exclusive

ds-type-limit-num

Description Limit the field length

Type: number

Range: 0-256

Default: 0

Mutual Exclusion: ds-type-limit-num and ds-type-no-limit are mutually exclusive

ds-type-no-limit

Description Print the field as much as possible

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: ds-type-no-limit and ds-type-limit-num are mutually exclusive

length-limit-flag

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

naptr-type-limit-num

Description Limit the field length

Type: number

Range: 0-256

Default: 0

Mutual Exclusion: naptr-type-limit-num and naptr-type-no-limit are mutually exclusive

naptr-type-no-limit

Description Print the field as much as possible

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: naptr-type-no-limit and naptr-type-limit-num are mutually exclusive

opt-type-limit-num

Description Limit the field length

Type: number

Range: 0-256

Default: 0

Mutual Exclusion: opt-type-limit-num and opt-type-no-limit are mutually exclusive

opt-type-no-limit

Description Print the field as much as possible

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: opt-type-no-limit and opt-type-limit-num are mutually exclusive

other-data

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

public-key

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rdata-field

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

response-type-name

Description ‘TXT’: TXT; ‘RRSIG’: RRSIG; ‘TSIG’: TSIG; ‘DNSKEY’: DNSKEY; ‘DS’: DS; ‘CAA’: CAA; ‘NAPTR’: NAPTR; ‘OPT’: OPT;

Type: string

Supported Values: TXT, RRSIG, TSIG, DNSKEY, DS, CAA, NAPTR, OPT

rrsig-type-limit-num

Description Limit the field length

Type: number

Range: 0-256

Default: 0

Mutual Exclusion: rrsig-type-limit-num and rrsig-type-no-limit are mutually exclusive

rrsig-type-no-limit

Description Print the field as much as possible

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: rrsig-type-no-limit and rrsig-type-limit-num are mutually exclusive

service-field

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

signature

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tsig-type-limit-num

Description Limit the field length

Type: number

Range: 0-256

Default: 0

Mutual Exclusion: tsig-type-limit-num and tsig-type-no-limit are mutually exclusive

tsig-type-no-limit

Description Print the field as much as possible

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: tsig-type-no-limit and tsig-type-limit-num are mutually exclusive

txt-data

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

txt-type-limit-num

Description Limit the field length

Type: number

Range: 0-256

Default: 0

Mutual Exclusion: txt-type-limit-num and txt-type-no-limit are mutually exclusive

txt-type-no-limit

Description Print the field as much as possible

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: txt-type-no-limit and txt-type-limit-num are mutually exclusive

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

value-field

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0