scaleout cluster¶

Configure scaleout cluster

cluster Specification¶

Parameter Value

Type Collection

Object Key(s) cluster-id

Collection Name cluster-list

Collection URI /axapi/v3/scaleout/cluster

Element Name cluster

Element URI /axapi/v3/scaleout/cluster/{cluster-id}

Element Attributes cluster_attributes

Partition Visibility shared

Schema cluster schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/scaleout/cluster	cluster attributes
Create List	POST	/axapi/v3/scaleout/cluster	cluster attributes
Get Object	GET	/axapi/v3/scaleout/cluster/{cluster-id}	cluster attributes
Get List	GET	/axapi/v3/scaleout/cluster	cluster-list
Modify Object	POST	/axapi/v3/scaleout/cluster/{cluster-id}	cluster attributes
Replace Object	PUT	/axapi/v3/scaleout/cluster/{cluster-id}	cluster attributes
Replace List	PUT	/axapi/v3/scaleout/cluster	cluster-list
Delete Object	DELETE	/axapi/v3/scaleout/cluster/{cluster-id}	cluster attributes

cluster-list¶

cluster-list is JSON List of cluster attributes

cluster-list : [

{ cluster attributes },

{ cluster attributes },

…

]

cluster attributes¶

cluster-devices

Description: cluster-devices is a JSON Block. Please see below for cluster-devices

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices

cluster-id

Description Scaleout cluster-id

Type: number

Range: 1-64

db-config

Description: db-config is a JSON Block. Please see below for db-config

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/db-config

device-groups

Description: device-groups is a JSON Block. Please see below for device-groups

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/device-groups

local-device

Description: local-device is a JSON Block. Please see below for local-device

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device

service-config

Description: service-config is a JSON Block. Please see below for service-config

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/service-config

slog-level

Description Set the level of slog for Scaleout

Type: number

Range: 1-8

Default: 5

tracking-template

Description: tracking-template is a JSON Block. Please see below for tracking-template

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/tracking-template

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

local-device¶

Specification Value

Type object

action

Description ‘enable’: enable; ‘disable’: disable;

Type: string

Supported Values: enable, disable

Default: enable

cluster-mode

Description ‘layer-2’: Nodes in cluster are layer 2 connected (default mode); ‘layer-3’: Nodes in cluster are l3 connected;

Type: string

Supported Values: layer-2, layer-3

Default: layer-2

exclude-interfaces

Description: exclude-interfaces is a JSON Block. Please see below for local-device_exclude-interfaces

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/exclude-interfaces

id

Description

Type: number

Range: 1-16

l2-redirect

Description: l2-redirect is a JSON Block. Please see below for local-device_l2-redirect

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/l2-redirect

priority

Description

Type: number

Range: 1-255

session-sync

Description: session-sync is a JSON Block. Please see below for local-device_session-sync

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync

start-delay

Description

Type: number

Range: 10-300

tracking-template

Description: tracking-template is a JSON Block. Please see below for local-device_tracking-template

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template

traffic-redirection

Description: traffic-redirection is a JSON Block. Please see below for local-device_traffic-redirection

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

local-device_session-sync¶

Specification Value

Type object

follow-shared

Description Follow shared partition for session sync

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

interfaces

Description: interfaces is a JSON Block. Please see below for local-device_session-sync_interfaces

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync/interfaces

reachability-options

Description: reachability-options is a JSON Block. Please see below for local-device_session-sync_reachability-options

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync/reachability-options

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

local-device_session-sync_interfaces¶

Specification Value

Type object

eth-cfg

Type: List

loopback-cfg

Type: List

trunk-cfg

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve-cfg

Type: List

local-device_session-sync_interfaces_ve-cfg¶

Specification Value

Type list

Block object keys

ve

Description Virtual ethernet Interface (Virtual ethernet interface number)

Type: number

Range: 2-4094

local-device_session-sync_interfaces_loopback-cfg¶

Specification Value

Type list

Block object keys

loopback

Description Loopback Interface(Not applicable in ‘layer-2’ mode) (Loopback interface number)

Type: number

Range: 0-10

local-device_session-sync_interfaces_trunk-cfg¶

Specification Value

Type list

Block object keys

trunk

Description Trunk Interface (Trunk interface number)

Type: number

Range: 1-4096

local-device_session-sync_interfaces_eth-cfg¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet Interface (Ethernet interface number)

Type: number

Format: interface

local-device_session-sync_reachability-options¶

Specification Value

Type object

skip-default-route

Description Do not choose default route for redirection(Not applicable in ‘layer-2’ mode)

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

local-device_exclude-interfaces¶

Specification Value

Type object

eth-cfg

Type: List

loopback-cfg

Type: List

trunk-cfg

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve-cfg

Type: List

local-device_exclude-interfaces_ve-cfg¶

Specification Value

Type list

Block object keys

ve

Description Virtual ethernet Interface (Virtual ethernet interface number)

Type: number

Range: 2-4094

local-device_exclude-interfaces_loopback-cfg¶

Specification Value

Type list

Block object keys

loopback

Description Loopback Interface (Loopback interface number)

Type: number

Range: 0-10

local-device_exclude-interfaces_trunk-cfg¶

Specification Value

Type list

Block object keys

trunk

Description Trunk Interface (Trunk interface number)

Type: number

Range: 1-4096

local-device_exclude-interfaces_eth-cfg¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet Interface (Ethernet interface number)

Type: number

Format: interface

local-device_l2-redirect¶

Specification Value

Type object

ethernet-vlan

Description VLAN ID

Type: number

Range: 2-4094

redirect-eth

Description Ethernet port (Port Value)

Type: number

Format: interface

Mutual Exclusion: redirect-eth and redirect-trunk are mutually exclusive

redirect-trunk

Description L2 Trunk group

Type: number

Range: 1-4096

Mutual Exclusion: redirect-trunk and redirect-eth are mutually exclusive

trunk-vlan

Description VLAN ID

Type: number

Range: 2-4094

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

local-device_traffic-redirection¶

Specification Value

Type object

follow-shared

Description Follow shared partition for redirection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

interfaces

Description: interfaces is a JSON Block. Please see below for local-device_traffic-redirection_interfaces

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection/interfaces

reachability-options

Description: reachability-options is a JSON Block. Please see below for local-device_traffic-redirection_reachability-options

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection/reachability-options

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

local-device_traffic-redirection_interfaces¶

Specification Value

Type object

eth-cfg

Type: List

loopback-cfg

Type: List

trunk-cfg

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve-cfg

Type: List

local-device_traffic-redirection_interfaces_ve-cfg¶

Specification Value

Type list

Block object keys

ve

Description Virtual ethernet Interface (Virtual ethernet interface number)

Type: number

Range: 2-4094

local-device_traffic-redirection_interfaces_loopback-cfg¶

Specification Value

Type list

Block object keys

loopback

Description Loopback Interface (Loopback interface number)

Type: number

Range: 0-10

local-device_traffic-redirection_interfaces_trunk-cfg¶

Specification Value

Type list

Block object keys

trunk

Description Trunk Interface (Trunk interface number)

Type: number

Range: 1-4096

local-device_traffic-redirection_interfaces_eth-cfg¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet Interface (Ethernet interface number)

Type: number

Format: interface

local-device_traffic-redirection_reachability-options¶

Specification Value

Type object

skip-default-route

Description Do not choose default route for redirection

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

local-device_tracking-template¶

Specification Value

Type object

multi-template-list

Type: List

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template/{multi-template}

template-list

Type: List

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/template/{template}

local-device_tracking-template_multi-template-list¶

Specification Value

Type list

Block object keys

action

Description ‘down’: node stops processing user traffic; ‘exit-cluster’: node exits scaleout cluster;

Type: string

Supported Values: down, exit-cluster

multi-template

Description bind multi tracking template name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

template

Type: List

threshold

Description action triggering threshold

Type: number

Range: 1-65535

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

local-device_tracking-template_multi-template-list_template¶

Specification Value

Type list

Block object keys

partition-name

Description Partition name

Type: string

Maximum Length: 14 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/partition

template-name

Description bind tracking template name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

local-device_tracking-template_template-list¶

Specification Value

Type list

Block object keys

template

Description bind tracking template name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

threshold-cfg

Type: List

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

local-device_tracking-template_template-list_threshold-cfg¶

Specification Value

Type list

Block object keys

action

Description ‘down’: node stops processing user traffic; ‘exit-cluster’: node exits scaleout cluster;

Type: string

Supported Values: down, exit-cluster

threshold

Description action triggering threshold

Type: number

Range: 1-65535

cluster-devices¶

Specification Value

Type object

cluster-discovery-timeout

Description: cluster-discovery-timeout is a JSON Block. Please see below for cluster-devices_cluster-discovery-timeout

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/cluster-discovery-timeout

device-id-list

Type: List

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id}

enable

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

minimum-nodes

Description: minimum-nodes is a JSON Block. Please see below for cluster-devices_minimum-nodes

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/minimum-nodes

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

cluster-devices_cluster-discovery-timeout¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

cluster-devices_device-id-list¶

Specification Value

Type list

Block object keys

action

Description ‘enable’: enable; ‘disable’: disable;

Type: string

Supported Values: enable, disable

Default: enable

ip

Description

Type: string

Format: ipv4-address

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

cluster-devices_minimum-nodes¶

Specification Value

Type object

minimum-nodes-num

Description Specify the minimum number of the node required to start service

Type: number

Range: 0-16

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

device-groups¶

Specification Value

Type object

device-group-list

Type: List

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/device-groups/device-group/{device-group}

enable

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

device-groups_device-group-list¶

Specification Value

Type list

Block object keys

device-group

Description scaleout device group

Type: number

Range: 1-16

device-id-list

Type: List

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

device-groups_device-group-list_device-id-list¶

Specification Value

Type list

Block object keys

device-id-end

Description

Type: number

device-id-start

Description

Type: number

service-config¶

Specification Value

Type object

enable

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

template-list

Type: List

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/service-config/template/{name}

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

service-config_template-list¶

Specification Value

Type list

Block object keys

bucket-count

Description Number of traffic buckets

Type: number

Range: 1-256

Default: 256

device-group

Description Device group id

Type: number

Range: 1-16

name

Description Scaleout template Name

Type: string

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

db-config¶

Specification Value

Type object

broken-detect-timeout

Description database connection broken detection timeout (mseconds) (12000 mseconds for default)

Type: number

Range: 500-120000

Default: 12000

client-recv-timeout

Description

Type: number

Range: 50-100000

Default: 13000

clientPort

Description client session port

Type: number

Range: 100-65535

elect-conn-timeout

Description election connection timeout (mseconds) (1200 for default)

Type: number

Range: 50-15000

Default: 1200

initLimit

Description

Type: number

Range: 1-500

loopback-intf-support

Description support loopback interface for scaleout database (enabled by default)

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

maxSessionTimeout

Description

Type: number

Range: 50-100000

Default: 30000

minSessionTimeout

Description

Type: number

Range: 50-100000

Default: 100

more-election-packet

Description send more election packet in election period (enabled by default)

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

syncLimit

Description

Type: number

Range: 1-500

tickTime

Description

Type: number

Range: 50-10000

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

tracking-template¶

Specification Value

Type object

template-list

Type: List

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/tracking-template/template/{template}

tracking-template_template-list¶

Specification Value

Type list

Block object keys

template

Description bind tracking template name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

threshold-cfg

Type: List

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

tracking-template_template-list_threshold-cfg¶

Specification Value

Type list

Block object keys

action

Description ‘down’: node stops processing user traffic; ‘exit-cluster’: node exits scaleout cluster;

Type: string

Supported Values: down, exit-cluster

threshold

Description action triggering threshold

Type: number

Range: 1-65535