Edit Node Pool
Api to modify Kubernetes Nodepool for Telco Cloud Automation
Request
URI
PUT
https://{api_host}/telco/api/caas/v2/clusters/{clusterName}/nodepools/{nodepoolName}
COPY
Path Parameters
string
clusterName
Required
Name of cluster on which nodepool needs to be modified
string
nodepoolName
Optional
Name of the nodepool which has to be modified
Query Parameters
string
mgmtClusterName
Optional
Name of the management cluster where the request has to be executed
string
tcaCpId
Optional
Id of the TCA CP where the request has to be routed.
Header Parameters
integer
Priority
Optional
Priority of the current task
Request Body
modify nodepool payload
nodepool of type(s) application/json
Required
{
"lastUpdated": "lastUpdated",
"metadata": {
"createdByIntent": "createdByIntent",
"modifiedByIntent": "modifiedByIntent",
"tcaCpId": "tcaCpId",
"resourceVersion": 0.8008281904610115,
"clusterName": "clusterName",
"name": "name",
"mgmtClusterName": "mgmtClusterName",
"annotations": {
"templateName": "templateName",
"templateNodepoolName": "templateNodepoolName"
}
},
"creationUser": "creationUser",
"intentQueued": true,
"creationDate": "creationDate",
"spec": {
"template": "template",
"diskGiB": 5,
"autoscaler": {
"enable": true,
"minSize0": 1,
"maxSize0": 6
},
"numCPUs": 9,
"datastore": "datastore",
"replicas": 2,
"kubeadmConfigTemplate": {
"joinConfiguration": {
"nodeRegistration": {
"kubeletExtraArgs": {
"key": "kubeletExtraArgs"
}
}
}
},
"cloudMachineTemplate": {
"type": "type",
"vSphereMachine": {
"template": "template",
"cloneMode": "fullClone",
"numCoresPerSocket": 5,
"folder": "folder",
"datastore": "datastore",
"datacenter": "datacenter",
"storagePolicyName": "storagePolicyName",
"resourcePool": "resourcePool"
}
},
"datacenter": "datacenter",
"storagePolicyName": "storagePolicyName",
"customisations": {
"networkAdapters": [
{
"networkName": "networkName",
"interfaceName": "interfaceName",
"mtu": 4.145608029883936
},
{
"networkName": "networkName",
"interfaceName": "interfaceName",
"mtu": 4.145608029883936
}
]
},
"memoryMiB": 2,
"pause": true,
"labels": {
"key": "labels"
},
"network": {
"devices": [
{
"dhcp4": true,
"nameservers": [
"nameservers",
"nameservers"
],
"dhcp6": true,
"networkName": "networkName",
"gateway6": "gateway6",
"gateway4": "gateway4",
"mtu": 7
},
{
"dhcp4": true,
"nameservers": [
"nameservers",
"nameservers"
],
"dhcp6": true,
"networkName": "networkName",
"gateway6": "gateway6",
"gateway4": "gateway4",
"mtu": 7
}
]
},
"cloneMode": "fullClone",
"numCoresPerSocket": 3,
"folder": "folder",
"tcaBomReleaseRef": {
"name": "name"
},
"clusterName": "clusterName",
"healthCheck": {
"unhealthyConditions": [
{
"type": "type",
"timeout": "timeout",
"status": "status"
},
{
"type": "type",
"timeout": "timeout",
"status": "status"
}
],
"nodeStartupTimeout": "nodeStartupTimeout",
"maxUnhealthy": "maxUnhealthy"
},
"cloudProvider": {
"vimId": "vimId"
},
"strategy": {
"type": "type",
"rollingUpdate": {
"maxSurge": "",
"maxUnavailable": ""
}
},
"resourcePool": "resourcePool"
},
"status": {
"needUpgrade": false,
"deleteAccepted": true,
"resourceVersion": 7.386281948385884,
"opstatus": "processing",
"hostProfile": "hostProfile",
"computeResource": {
"name": "name",
"type": "type"
},
"conditions": [
{
"severity": "Warning",
"reason": "reason",
"lastTransitionTime": "lastTransitionTime",
"type": "Ready",
"message": "message",
"status": true
},
{
"severity": "Warning",
"reason": "reason",
"lastTransitionTime": "lastTransitionTime",
"type": "Ready",
"message": "message",
"status": true
}
],
"pause": false
}
}string
lastUpdated
Optional
lastUpdated
string
creationDate
Optional
creationDate
string
creationUser
Optional
creationUser
boolean
intentQueued
Optional
intentQueued
Responses
200
Successfully accepted nodepool request
Returns nodepool of type(s) application/json
{
"lastUpdated": "lastUpdated",
"metadata": {
"createdByIntent": "createdByIntent",
"modifiedByIntent": "modifiedByIntent",
"tcaCpId": "tcaCpId",
"resourceVersion": 0.8008281904610115,
"clusterName": "clusterName",
"name": "name",
"mgmtClusterName": "mgmtClusterName",
"annotations": {
"templateName": "templateName",
"templateNodepoolName": "templateNodepoolName"
}
},
"creationUser": "creationUser",
"intentQueued": true,
"creationDate": "creationDate",
"spec": {
"template": "template",
"diskGiB": 5,
"autoscaler": {
"enable": true,
"minSize0": 1,
"maxSize0": 6
},
"numCPUs": 9,
"datastore": "datastore",
"replicas": 2,
"kubeadmConfigTemplate": {
"joinConfiguration": {
"nodeRegistration": {
"kubeletExtraArgs": {
"key": "kubeletExtraArgs"
}
}
}
},
"cloudMachineTemplate": {
"type": "type",
"vSphereMachine": {
"template": "template",
"cloneMode": "fullClone",
"numCoresPerSocket": 5,
"folder": "folder",
"datastore": "datastore",
"datacenter": "datacenter",
"storagePolicyName": "storagePolicyName",
"resourcePool": "resourcePool"
}
},
"datacenter": "datacenter",
"storagePolicyName": "storagePolicyName",
"customisations": {
"networkAdapters": [
{
"networkName": "networkName",
"interfaceName": "interfaceName",
"mtu": 4.145608029883936
},
{
"networkName": "networkName",
"interfaceName": "interfaceName",
"mtu": 4.145608029883936
}
]
},
"memoryMiB": 2,
"pause": true,
"labels": {
"key": "labels"
},
"network": {
"devices": [
{
"dhcp4": true,
"nameservers": [
"nameservers",
"nameservers"
],
"dhcp6": true,
"networkName": "networkName",
"gateway6": "gateway6",
"gateway4": "gateway4",
"mtu": 7
},
{
"dhcp4": true,
"nameservers": [
"nameservers",
"nameservers"
],
"dhcp6": true,
"networkName": "networkName",
"gateway6": "gateway6",
"gateway4": "gateway4",
"mtu": 7
}
]
},
"cloneMode": "fullClone",
"numCoresPerSocket": 3,
"folder": "folder",
"tcaBomReleaseRef": {
"name": "name"
},
"clusterName": "clusterName",
"healthCheck": {
"unhealthyConditions": [
{
"type": "type",
"timeout": "timeout",
"status": "status"
},
{
"type": "type",
"timeout": "timeout",
"status": "status"
}
],
"nodeStartupTimeout": "nodeStartupTimeout",
"maxUnhealthy": "maxUnhealthy"
},
"cloudProvider": {
"vimId": "vimId"
},
"strategy": {
"type": "type",
"rollingUpdate": {
"maxSurge": "",
"maxUnavailable": ""
}
},
"resourcePool": "resourcePool"
},
"status": {
"needUpgrade": false,
"deleteAccepted": true,
"resourceVersion": 7.386281948385884,
"opstatus": "processing",
"hostProfile": "hostProfile",
"computeResource": {
"name": "name",
"type": "type"
},
"conditions": [
{
"severity": "Warning",
"reason": "reason",
"lastTransitionTime": "lastTransitionTime",
"type": "Ready",
"message": "message",
"status": true
},
{
"severity": "Warning",
"reason": "reason",
"lastTransitionTime": "lastTransitionTime",
"type": "Ready",
"message": "message",
"status": true
}
],
"pause": false
}
}string
lastUpdated
Optional
lastUpdated
string
creationDate
Optional
creationDate
string
creationUser
Optional
creationUser
boolean
intentQueued
Optional
intentQueued
400
Bad Request
Returns errorResponse of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
500
Internal Server Error
Returns errorResponse of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
On This Page
Node Pool Operations
POST
Create Node Pool
DELETE
Delete Node Pool
PUT
Edit Node Pool
GET
Get All Node Pools
GET
Get Node Pool
GET
Get Node Pool Customization