Sign in
ResourceUnits

Get a resource unit

Changed on
get/api/v1/resourcepools/{pool}/units/{unit}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/resourcepools/{pool}/units/{unit}
  • Auth: none declared

Path parameters

poolstring required
unitstring required

Response

Resource unit detail.

annotationsStringMap
descriptionstring

Free-text unit description.

limitsResourceMap required

Kubernetes-style resource quantity map (e.g., {"cpu": "100", "memory": "1Ti", "nvidia.com/gpu": "8"}).

namestring required

Resource unit (shape) name, unique within the pool.

nodeSelectorStringMap
requestsResourceMap required

Kubernetes-style resource quantity map (e.g., {"cpu": "100", "memory": "1Ti", "nvidia.com/gpu": "8"}).

Example response

{
  "annotations": {
    "axisml.io/cost-center": "ml-platform",
    "axisml.io/created-by": "admin"
  },
  "description": "2x A100 GPU compute unit.",
  "limits": {
    "cpu": "16",
    "memory": "128Gi",
    "nvidia.com/gpu": "2"
  },
  "name": "a100-2x",
  "nodeSelector": {
    "arch": "amd64",
    "gpu.product": "A100"
  },
  "requests": {
    "cpu": "16",
    "memory": "128Gi",
    "nvidia.com/gpu": "2"
  }
}

Changes

  • 1a4808c79a19Revision changes
    • warning

      removed the optional property from the response with the status

  • d51e2e0e6970Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status