scaleout cluster¶
Configure scaleout cluster
cluster Specification¶
Type Collection Object Key(s) cluster-id Collection Name cluster-list Collection URI /axapi/v3/scaleout/cluster Element Name cluster Element URI /axapi/v3/scaleout/cluster/{cluster-id} Element Attributes cluster_attributes Schema cluster schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/scaleout/cluster | ||
Create List | POST | /axapi/v3/scaleout/cluster | ||
Get Object | GET | /axapi/v3/scaleout/cluster/{cluster-id} | ||
Get List | GET | /axapi/v3/scaleout/cluster | ||
Modify Object | POST | /axapi/v3/scaleout/cluster/{cluster-id} | ||
Replace Object | PUT | /axapi/v3/scaleout/cluster/{cluster-id} | ||
Replace List | PUT | /axapi/v3/scaleout/cluster | ||
Delete Object | DELETE | /axapi/v3/scaleout/cluster/{cluster-id} |
cluster-list¶
cluster-list is JSON List of cluster attributes
cluster-list : [
]
cluster attributes¶
cluster-devices
Description: cluster-devices is a JSON Block. Please see below for cluster-devices
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{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/{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/{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/{cluster-id}/service-config
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
Type: List
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id}
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
Type: List
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/device-groups/device-group/{device-group}
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: Listuser-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
Type: List
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/service-config/template/{name}
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