scaleout cluster device-groups

Configure scaleout device groups

device-groups Specification

Parameter	Value
Type	Configuration Resource
Element Name	device-groups
Element URI	/axapi/v3/scaleout/cluster/{cluster-id}/device-groups
Element Attributes	device-groups_attributes
Partition Visibility	shared
Schema	device-groups schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/scaleout/cluster/{cluster-id}/device-groups	device-groups attributes	example close
POST /axapi/v3/scaleout/cluster/1/device-groups Payload: { "device-groups": { "device-group-list": [ { "device-group": 1, "user-tag": "a" } ] } }
Get Object	GET	/axapi/v3/scaleout/cluster/{cluster-id}/device-groups	device-groups attributes	example close
GET /axapi/v3/scaleout/cluster/1/device-groups Reponse: { "device-groups": { "uuid": "eff336dc-65a7-11f0-b71f-6fe93075fb18", "device-group-list": [ { "device-group": 1, "uuid": "eff34780-65a7-11f0-b71f-6fe93075fb18", "user-tag": "a", "a10-url": "/axapi/v3/scaleout/cluster/1/device-groups/device-group/1" } ], "a10-url": "/axapi/v3/scaleout/cluster/1/device-groups" } }
Modify Object	POST	/axapi/v3/scaleout/cluster/{cluster-id}/device-groups	device-groups attributes
Replace Object	PUT	/axapi/v3/scaleout/cluster/{cluster-id}/device-groups	device-groups attributes	example close
PUT /axapi/v3/scaleout/cluster/1/device-groups Payload: { "device-groups": { "device-group-list": [ { "device-group": 1, "device-id-list": [ { "device-id-start": 2, "device-id-end": 2 } ] } ] } }
Delete Object	DELETE	/axapi/v3/scaleout/cluster/{cluster-id}/device-groups	device-groups attributes	example close
DELETE /axapi/v3/scaleout/cluster/1/device-groups Reponse: { "response": { "status": "OK" } }

device-groups attributes

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-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-group-list_device-id-list

Specification	Value
Type	list
Block object keys

device-id-end

Description

Type: number

device-id-start

Description

Type: number