Skip to main content

List Node Pools of a Cluster

Returns the worker node pools attached to a cluster. Each pool reports its own service_id, worker role (cardinality, min/max VMs, elasticity and scheduled policies, policy_type, backing plan_id), state, node id list, and committed-pricing options. Use the cluster service_id returned by List.

GET/api/v1/kubernetes/node-pool-services/{service_id}

Path parameters

  • service_idPathintegerrequired

    The cluster service_id, as returned by List.

    • required
    • must be a valid cluster service ID
    example12345

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the cluster.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Responses

200Successful response
object
codeinteger
example200
dataarray

Worker node pools of the cluster.

errorsobject
messagestring
exampleSuccess