clusters

Check Cluster Capacity

Tell, before creating or resizing a workload, whether it fits on a shared cluster.

Shared clusters cap the CPU and memory requests of everything in the tenant; a pod over the cap is rejected at admission and ends up as a failed deployment or database. This answers the same question up front from the tenant's live quota. For dedicated clusters and clusters that are not running yet applies is false.

post/api/v1/clusters/{cluster_id}/capacity-check

Request

  • Base URL: https://api.mengi.cloud (the document declares no server; this is the origin it was published from)
  • URL: https://api.mengi.cloud/api/v1/clusters/{cluster_id}/capacity-check
  • Auth: none declared

Path parameters

cluster_idstring uuid required

Request body

kind'deployment' | 'database' required
cpu_requestnumber
memory_request_mbinteger
replicasinteger
deployment_typestring
enginestring nullable
tierstring nullable
exclude_deployment_idstring uuid nullable
exclude_database_idstring uuid nullable

Response

Successful Response

appliesboolean required
fitsboolean required
messagestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.