Get Node Pool
API to get Node Pool of a Kubernetes Cluster
Request
URI
GET
https://{api_host}/tca/caas/api/v2/orgs/{orgId}/clusters/{clusterUUID}/nodepools/{nodepoolName}
COPY
Path Parameters
string
orgId
Optional
The identifier of the tenant
string
clusterUUID
Required
UUID of cluster where node pool is created
string
nodepoolName
Required
Name of node pool
Query Parameters
string
mgmtClusterName
Optional
Name of management cluster of the given cluster. If given cluster is management cluster, this is not required
string
tcaCpId
Required
TCA-CP id of management cluster managing given cluster
Responses
200
Successfully returned node pool
Returns nodepool of type(s) application/json
{
"metadata": {
"resourceVersion": "number",
"name": "string",
"clusterName": "string",
"mgmtClusterName": "string",
"tcaCpId": "string",
"createdByIntent": "string",
"modifiedByIntent": "string",
"annotations": {
"templateName": "string",
"templateNodepoolName": "string"
}
},
"spec": {
"autoscaler": {
"enable": false,
"maxSize0": 0,
"minSize0": 0
},
"class": "string",
"cloneMode": "string",
"cloudMachineTemplate": {
"type": "string",
"vSphereMachine": {
"cloneMode": "string",
"datacenter": "string",
"datastore": "string",
"folder": "string",
"numCoresPerSocket": 0,
"resourcePool": "string",
"storagePolicyName": "string",
"template": "string"
}
},
"clusterName": "string",
"datacenter": "string",
"datastore": "string",
"diskGiB": 0,
"folder": "string",
"healthCheck": {
"maxUnhealthy": "string",
"nodeStartupTimeout": "string",
"unhealthyConditions": [
{
"status": "string",
"timeout": "string",
"type": "string"
}
]
},
"kubeadmConfigTemplate": {
"joinConfiguration": {
"nodeRegistration": {}
}
},
"memoryMiB": 0,
"network": {
"devices": [
{
"dhcp4": false,
"dhcp6": false,
"gateway4": "string",
"gateway6": "string",
"ipAddressPools": [
{
"name": "string"
}
],
"mtu": 0,
"nameservers": [
"string"
],
"networkName": "string"
}
]
},
"numCPUs": 0,
"numCoresPerSocket": 0,
"pause": false,
"replicas": 0,
"resourcePool": "string",
"storagePolicyName": "string",
"strategy": {
"rollingUpdate": {
"deletePolicy": "string"
},
"type": "string"
},
"tcaBomReleaseRef": {
"name": "string"
},
"template": "string",
"variables": [
{
"definitionFrom": "string",
"name": "string"
}
],
"cloudProvider": {
"vimId": "string"
},
"customisations": {
"networkAdapters": [
{
"networkName": "string",
"interfaceName": "string",
"mtu": "number"
}
]
}
},
"status": {
"needUpgrade": false,
"resourceVersion": "number",
"opstatus": "string",
"hostProfile": "string",
"pause": false,
"computeResource": {
"name": "string",
"type": "string"
},
"deleteAccepted": false,
"conditions": [
{
"lastTransitionTime": "string",
"status": "string",
"type": "string",
"reason": "string",
"message": "string",
"severity": "string"
}
]
},
"lastUpdated": "string",
"creationDate": "string",
"creationTenantId": "string",
"creationUser": "string",
"intentQueued": false
}object
metadata
Optional
metadata
object
spec
Optional
properties of NodePools
object
status
Optional
status
string
lastUpdated
Optional
lastUpdated
string
creationDate
Optional
creationDate
string
creationTenantId
Optional
creationTenantId
string
creationUser
Optional
creationUser
boolean
intentQueued
Optional
intentQueued
400
Returns BadRequest of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
500
Returns InternalServerError of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}