search
Contact support

NodePools

Node pools assist in managing heterogeneous resources effectively. A node pool is a set of nodes grouped into a bucket of resources using a predefined (for example, GPU-Type) or administrator-defined label (for example, key & value). For more information, see Node Poolsarrow-up-right.

hashtag
Get the node pool metrics data.

get

Retrieve the node pool metrics data by Universally Unique Identifier (UUID).

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clusterUuidstring · uuid · min: 1Required

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc
nodepoolNamestringRequired

The unique nodepool name.

Example: default
Query parameters
startstring · date-timeRequired

Start date of time range to fetch data in ISO 8601 timestamp format.

Example: 2023-06-06T12:09:18.211Z
endstring · date-timeRequired

End date of time range to fetch data in ISO 8601 timestamp format.

Example: 2023-06-07T12:09:18.211Z
numberOfSamplesinteger · max: 1000Optional

The number of samples to take in the specified time range.

Default: 20Example: 20
Responses
chevron-right
200

Executed successfully.

get
/api/v1/clusters/{clusterUuid}/nodepools/{nodepoolName}/metrics

hashtag
Get nodepools

get

Get nodepools

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
filterBystring[]Optional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: ["name!=some-name"]
sortBystring · enumOptional

Sort results by a parameters.

Possible values:
sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:
offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100
limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50
Responses
chevron-right
200

ok

application/json
get
/api/v1/node-pools

hashtag
Create nodepool

post

Create nodepool

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
namestring · min: 1RequiredExample: v100
labelKeystring · min: 1Required

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type
labelValuestring · min: 1Required

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x
clusterIdstring · uuidRequiredExample: d73a738f-fab3-430a-8fa3-5241493d7128
overProvisioningRatiointeger · min: 1 · max: 5 · nullableOptionalDeprecatedDefault: 1Example: 1
gpuNetworkAccelerationLabelKeystring · nullableOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionstring · enum · nullableOptional

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Default: AutoPossible values:
networkTopologyIdstring · uuid · nullableOptional

The unique identifier for the network topology

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
post
/api/v1/node-pools

hashtag
Count nodepools

get

Count nodepools

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
filterBystring[]Optional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: ["name!=some-name"]
Responses
chevron-right
200

ok

application/json
get
/api/v1/node-pools/count

hashtag
Get nodepool

get

Get nodepool

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
nodepoolIdstringRequired

The unique id identifying the Node Pool.

Example: 17
Responses
chevron-right
200

Requested nodepool

application/json
get
/api/v1/node-pools/{nodepoolId}

hashtag
Update nodepool

put

Update nodepool

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
nodepoolIdstringRequired

The unique id identifying the Node Pool.

Example: 17
Body
labelKeystring · min: 1 · nullableOptional

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type
labelValuestring · min: 1 · nullableOptional

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x
overProvisioningRatiointeger · min: 1 · max: 5 · nullableOptionalDeprecatedDefault: 1Example: 1
gpuNetworkAccelerationLabelKeystring · nullableOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionstring · enum · nullableOptional

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Default: AutoPossible values:
networkTopologyIdstring · uuid · nullableOptional

The unique identifier for the network topology

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
chevron-right
200

Updated

application/json
put
/api/v1/node-pools/{nodepoolId}

hashtag
Delete nodepool

delete

Delete nodepool

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
nodepoolIdstringRequired

The unique id identifying the Node Pool.

Example: 17
Responses
delete
/api/v1/node-pools/{nodepoolId}

hashtag
Patch nodepool fields

patch

Update only specific fields of a nodepool

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
nodepoolIdstringRequired

The unique id identifying the Node Pool.

Example: 17
Body
labelKeystring · min: 1 · nullableOptional

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type
labelValuestring · min: 1 · nullableOptional

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x
overProvisioningRatiointeger · min: 1 · max: 5 · nullableOptionalDeprecatedDefault: 1Example: 1
gpuNetworkAccelerationLabelKeystring · nullableOptional

Label key by which to determine GPUNetworkAccelerationDetection nodes

gpuNetworkAccelerationDetectionstring · enum · nullableOptional

GPUNetworkAccelerationDetection is a strategy to use for GPU Network Acceleration detection

Default: AutoPossible values:
networkTopologyIdstring · uuid · nullableOptional

The unique identifier for the network topology

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
chevron-right
200

Updated

application/json
patch
/api/v1/node-pools/{nodepoolId}
Deprecated

hashtag
Get the cluster's Node Pools.

get

Retrieve all the node pools with details from the cluster by Universally Unique Identifier (UUID). Deprecated, please use /api/v1/node-pools instead.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clusterIdstring · uuidRequired

Unique identifier of the cluster

Responses
chevron-right
200

Node pools returned successfully.

application/json
get
/v1/k8s/clusters/{clusterId}/node-pools
Deprecated

hashtag
Create a Node Pool.

post

Use to create a node pool in a cluster by Universally Unique Identifier (UUID). Deprecated, please use /api/v1/node-pools instead.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clusterIdstring · uuidRequired

Unique identifier of the cluster

Body
namestringOptional

Node Pool Name

Example: node-pool-a
overProvisioningRatiointegerOptionalDefault: 1Example: 1
labelKeystringOptional

Label key for associated nodes to the Node Pool (with value as in labelValue)

Example: node-type
labelValuestringOptional

Label value for associated nodes to the Node Pool (with key as in labelKey)

Example: type-x
Responses
post
/v1/k8s/clusters/{clusterId}/node-pools
No content
Deprecated

hashtag
Update labels of a Node Pool.

put

Use to update the labels of a node pool. Deprecated, please use PATCH /api/v1/node-pools/{id} instead.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clusterIdstring · uuidRequired

Unique identifier of the cluster

idintegerRequired

The unique id identifying the Node Pool.

Body
labelKeystringOptional

key of node label for pool

Example: node-type
labelValuestringOptional

value of node label for pool

Example: type-x
Responses
put
/v1/k8s/clusters/{clusterId}/node-pools/{id}/labels
No content
Deprecated

hashtag
Update a Node Pool.

put

Use to update the details of a node pool by Universally Unique Identifier (UUID). Deprecated, please use PATCH /api/v1/node-pools/{id} instead.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clusterIdstring · uuidRequired

Unique identifier of the cluster

idintegerRequired

The unique id identifying the Node Pool.

Body
labelKeystringOptional

key of node label for pool

Example: node-type
labelValuestringOptional

value of node label for pool

Example: type-x
overProvisioningRatiointegerOptionalDefault: 1Example: 1
Responses
put
/v1/k8s/clusters/{clusterId}/node-pools/{id}
No content
Deprecated

hashtag
Delete a Node Pool by id.§

delete

Use to delete a node pool by Universally Unique Identifier (UUID). Deprecated, please use /api/v1/node-pools/{id} instead.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clusterIdstring · uuidRequired

Unique identifier of the cluster

idintegerRequired

The unique id identifying the Node Pool.

Responses
delete
/v1/k8s/clusters/{clusterId}/node-pools/{id}
No content
PreviousReportsNextNodes

Last updated