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:

OperationMethodURIPayload

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

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

cluster-id

Description Scaleout cluster-id

Type: number

Range: 1-64

device-groups

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

Type: Object

Refernce 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

Refernce 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

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

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

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

Maximum Length: 64 characters

Maximum Length: 1 characters

cluster-devices

Specification  
Type object

device-id-list

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

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

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

Specification  
Type object

device-group-list

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

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

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  
Type list
Block object keys  

device-id-end

Description

Type: number

device-id-start

Description

Type: number

service-config

Specification  
Type object

template-list

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

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

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