scaleout cluster cluster-devices¶

Configure devices in the cluster

cluster-devices Specification¶

Parameter Value

Type Configuration Resource

Element Name cluster-devices

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

Element Attributes cluster-devices_attributes

Partition Visibility shared

Schema cluster-devices schema

Operations Allowed:

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

cluster-devices attributes¶

cluster-discovery-timeout

Description: cluster-discovery-timeout is a JSON Block. Please see below for 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 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-discovery-timeout¶

Specification Value

Type object

timer-val

Description Cluster node discovery timeout value (secs (Default: 120))

Type: number

Range: 60-86400

Default: 120

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

device-id-list¶

Specification Value

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-16

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

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