ResourcePools

Update a resource pool

Changed on
patch/api/v1/resourcepools/{pool}

Request

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

Path parameters

poolstring required

Request body

annotationsStringMap
capacityResourceMap

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

descriptionstring

Updated free-text pool description.

labelsStringMap
nodeSelectorStringMap

Example request

{
  "capacity": {
    "cpu": "96",
    "memory": "768Gi",
    "nvidia.com/gpu": "12"
  },
  "description": "Updated A100 GPU resource pool.",
  "nodeSelector": {
    "axisml.io/gpu": "a100",
    "axisml.io/zone": "cn-east-1"
  }
}

Response

Updated pool.

annotationsStringMap
capacityResourceMap

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

createdAtstring date-time required

Time the pool was created.

descriptionstring

Free-text pool description.

labelsStringMap
namestring required

Cluster-scoped resource pool name (unique across the cluster).

nodeCountinteger

Number of nodes currently matched by the pool's node selector (read-only).

nodeSelectorStringMap
resourceVersionstring

Kubernetes resourceVersion for optimistic concurrency.

updatedAtstring date-time

Time the pool was last updated.

Example response

{
  "annotations": {
    "axisml.io/cost-center": "ml-platform",
    "axisml.io/created-by": "admin"
  },
  "capacity": {
    "cpu": "64",
    "memory": "512Gi",
    "nvidia.com/gpu": "8"
  },
  "createdAt": "2026-06-20T08:00:00Z",
  "description": "A100 GPU resource pool.",
  "labels": {
    "tier": "gpu"
  },
  "name": "gpu-a100",
  "nodeCount": 8,
  "nodeSelector": {
    "axisml.io/gpu": "a100"
  },
  "resourceVersion": "184321",
  "units": [
    {
      "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"
      }
    }
  ],
  "updatedAt": "2026-06-28T09:30:00Z"
}

Changes

  • 1a4808c79a19Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • d51e2e0e6970Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from object to no type

    • 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

    • 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

    • 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