Endpoint

/v1/capacity/clamp

GET

Retrieve the capacity clamp value in bytes. You can set this value by using a PUT API call or as an argument to the cluster creation API. The cluster uses this value to determine the maximum capacity that it can provision, regardless of the maximum capacity of the underlying storage.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_capacity_clamp",
  "type": "object",
  "properties": {
    "capacity_clamp": {
      "description": "The value, in bytes, to clamp usable capacity to",
      "type": "string"
    }
  }
}

PUT

Specify the capacity clamp value in bytes. This value limits maximum provisioned capacity. The actual provisioned space is limited to the maximum capacity of the underlying storage. In addition, the actual provisioned space is close to the requested value in bytes, without exceeding it. If the system applies this value successfully, it abandons quorum and allocates storage capacity in a new quorum.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_capacity_clamp",
  "type": "object",
  "properties": {
    "capacity_clamp": {
      "description": "The value, in bytes, to clamp usable capacity to",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success