Edit Node Pool
Api to modify Kubernetes Nodepool for Telco Cloud Automation
Request
URI
PUT
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 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
{
"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
Responses
200
Successfully accepted nodepool request
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"
}
]
}
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