scaleout

Configure Scaleout.

scaleout Specification

Type Collection
Object Key(s) cluster-id
Collection Name scaleout-list
Collection URI /axapi/v3/scaleout/
Element Name scaleout
Element URI /axapi/v3/scaleout/{cluster-id}
Element Attributes scaleout_attributes
Schema scaleout schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/scaleout/

scaleout Attributes

Create List

POST

/axapi/v3/scaleout/

scaleout Attributes

Get Object

GET

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

scaleout Attributes

Get List

GET

/axapi/v3/scaleout/

scaleout-list

Modify Object

POST

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

scaleout Attributes

Replace Object

PUT

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

scaleout Attributes

Replace List

PUT

/axapi/v3/scaleout/

scaleout-list

Delete Object

DELETE

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

scaleout Attributes

scaleout-list

scaleout-list is JSON List of scaleout Attributes

scaleout-list : [

scaleout Attributes

cluster-devices

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

Type: Object

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

cluster-id

Description: Scaleout cluster-id

Type: number

Range: 1-64

Required: Yes

device-groups

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

Type: Object

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

follow-vcs

Description:

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

local-device

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

Type: Object

Reference Object: /axapi/v3/scaleout/{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-id}/service-config

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

local-device

Specification
Type object

id

Description:

Type: number

Range: 1-8

priority

Description:

Type: number

Range: 1-255

uuid

Description: uuid of the object

Type: string

cluster-devices

Specification
Type object

device-id-list

Description: device-id-list is a JSON List . Please see below for l234_device-id-list

Type: List

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

uuid

Description: uuid of the object

Type: string

cluster-devices.device-id-list

Specification
Type list
Block object keys

action

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

Type: string

Supported Values: enable, disable

Default: enable

device-id

Description: scaleout device id

Type: number

Range: 1-8

ip

Description:

Type: string

Format: ipv4-address

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

device-groups

Specification
Type object

device-group-list

Description: device-group-list is a JSON List . Please see below for l234_device-group-list

Type: List

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

uuid

Description: uuid of the object

Type: string

device-groups.device-group-list

Specification
Type list
Block object keys

device-group

Description: scaletout device group

Type: number

Range: 1-16

device-id-list

Description: device-id-list is a JSON List . Please see below for l234_device-id-list

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

device-groups.device-group-list.device-id-list

Specification
Type list
Block object keys

device-id-end

Description:

Type: number

device-id-start

Description:

Type: number

service-config

Specification
Type object

template-list

Description: template-list is a JSON List . Please see below for l234_template-list

Type: List

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

uuid

Description: uuid of the object

Type: string

service-config.template-list

Specification
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

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string