slb template logging

You can use logging templates to send logs over TCP to external servers. This feature can be useful for external HTTP logging for HTTP load-balanced traffic and for content served from the ACOS RAM cache.

logging Specification

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
Schema logging schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/slb/template/logging/

logging Attributes

Create List

POST

/axapi/v3/slb/template/logging/

logging Attributes

Get Object

GET

/axapi/v3/slb/template/logging/{name}

logging Attributes

Get List

GET

/axapi/v3/slb/template/logging/

logging-list

Modify Object

POST

/axapi/v3/slb/template/logging/{name}

logging Attributes

Replace Object

PUT

/axapi/v3/slb/template/logging/{name}

logging Attributes

Replace List

PUT

/axapi/v3/slb/template/logging/

logging-list

Delete Object

DELETE

/axapi/v3/slb/template/logging/{name}

logging Attributes

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: Configures a log string.

Type: string

Format: string-rlx

keep-end

Description: Number of unmasked characters at the end.

Type: number

Range: 0-65535

Default: 0

keep-start

Description: Number of unmasked characters at the beginning.

Type: number

Range: 0-65535

Default: 0

local-logging

Description: Enable or disable local logging:

  • 0 - Disables local logging.
  • 1 - Enables local logging.

Type: number

Range: 0-1

Default: 0

mask

Description: Character to mask the matched pattern.

Type: string

Default: X

name

Description: Name of the template.

Type: string

Format: string-rlx

Required: Yes

pcre-mask

Description: Mask matched PCRE pattern in the log

Type: string

Format: string-rlx

pool

Description: Specify NAT pool or pool group

Type: string

Mutual Exclusion: pool and auto are mutually exclusive

Reference Object: /axapi/v3/ip/nat/pool

service-group

Description: Binds a service group of log servers to the logging template.

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/service-group

tcp-proxy

Description: TCP proxy template (TCP Proxy Config name)

Type: string

Default: default

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string