scaleout cluster cluster-devices device-id¶

Configure Scaleout devices

device-id Specification¶

Parameter Value

Type Collection

Object Key(s) device-id

Collection Name device-id-list

Collection URI /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/device-id

Element Name device-id

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

Element Attributes device-id_attributes

Partition Visibility shared

Schema device-id schema

Operations Allowed:

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

device-id-list¶

device-id-list is JSON List of device-id attributes

device-id-list : [

{ device-id attributes },

{ device-id attributes },

…

]

device-id attributes¶

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