Server Groups API

Server Groups API

The server groups REST API refers to the Rack Zone Awareness feature, which enables logical groupings of servers on a cluster where each server group physically belongs to a rack or availability zone.

Description

This feature provides the ability to specify that active and corresponding replica partitions be created on servers that are part of a separate rack or zone. For purposes of the server group REST API, racks or availability zones are represented as flat space of server groups with group names. To enable Rack Awareness, all servers in a cluster must be upgraded to use the Rack Awareness feature.

Note: The Rack Awareness feature with its server group capability is an Enterprise Edition feature.

The Server groups REST API provides the following capability:

  • Create server groups
  • Edit server groups
  • Delete server groups
  • Assign servers to server groups.
Table 1. Server group endpoints
HTTP method URI path Description Admin Role
GET /pools/default/serverGroups Retrieves information about a server group. Full, Cluster
POST /pools/default/serverGroups Creates a server group with a specific name. Full, Cluster
PUT /pools/default/serverGroups/<:uuid> Updates the server group information. Full, Cluster
PUT /pools/default/serverGroups?rev=<:number> Updates a server’s group memberships. Full, Cluster
DELETE /pools/default/serverGroups/<:uuid> Deletes a specific server group. Full, Cluster