slb template logging¶
Logging template
logging Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name logging-list Collection URI /axapi/v3/slb/template/logging Element Name logging Element URI /axapi/v3/slb/template/logging/{name} Element Attributes logging_attributes Partition Visibility shared Schema logging schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/template/logging | ||
Create List | POST | /axapi/v3/slb/template/logging | ||
Get Object | GET | /axapi/v3/slb/template/logging/{name} | ||
Get List | GET | /axapi/v3/slb/template/logging | ||
Modify Object | POST | /axapi/v3/slb/template/logging/{name} | ||
Replace Object | PUT | /axapi/v3/slb/template/logging/{name} | ||
Replace List | PUT | /axapi/v3/slb/template/logging | ||
Delete Object | DELETE | /axapi/v3/slb/template/logging/{name} |
logging-list¶
logging-list is JSON List of logging attributes
logging-list : [
]
logging attributes¶
auto
Description ‘auto’: Configure auto NAT for logging, default is auto enabled;
Type: string
Supported Values: auto
Default: auto
Mutual Exclusion: auto and pool are mutually exclusive
format
Description Specify a format string for web logging (format string(less than 250 characters) for web logging)
Type: string
Format: string-rlx
Maximum Length: 250 characters
Maximum Length: 1 characters
keep-end
Description Number of unmasked characters at the end (default: 0)
Type: number
Range: 0-65535
Default: 0
keep-start
Description Number of unmasked characters at the beginning (default: 0)
Type: number
Range: 0-65535
Default: 0
local-logging
Description 1 to enable local logging (1 to enable local logging, default 0)
Type: number
Range: 0-1
Default: 0
mask
Description Character to mask the matched pattern (default: X)
Type: string
Maximum Length: 1 characters
Maximum Length: 1 characters
Default: X
name
Description Logging Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
pcre-mask
Description Mask matched PCRE pattern in the log
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
pool
Description Specify NAT pool or pool group
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: pool, shared-partition-pool, and auto are mutually exclusive
Reference Object: /axapi/v3/ip/nat/pool
pool-shared
Description Specify NAT pool or pool group
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/nat/pool
service-group
Description Bind a Service Group to the logging template (Service Group Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/service-group
shared-partition-pool
Description Reference a NAT pool or pool group from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-pool and pool are mutually exclusive
shared-partition-tcp-proxy-template
Description Reference a TCP Proxy template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive
tcp-proxy
Description TCP Proxy Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/tcp-proxy
template-tcp-proxy-shared
Description TCP Proxy Template name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/tcp-proxy
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