Update Cluster Template
Api to update a cluster template for Telco Cloud Automation
Request
URI
PUT
https://{api_host}/tca/caas/api/v1/orgs/{orgId}/templates/{id}
COPY
Path Parameters
string
orgId
Optional
The identifier of the tenant
string
id
Required
id
Request Body
clusterTemplate of type(s) application/json
Required
{
"clusterType": "string",
"clusterConfig": {
"cni": [
{
"name": "string"
}
],
"csi": [
{
"name": "string",
"properties": {
"name": "string",
"isDefault": false,
"timeout": "string"
}
}
],
"kubernetesVersion": "string",
"tools": [
{
"name": "string",
"version": "string"
}
],
"networking": [
{
"name": "string"
}
]
},
"description": "string",
"masterNodes": [
{
"cpu": 0,
"memory": 0,
"name": "string",
"networks": [
{
"label": "string",
"isManagement": false
}
],
"storage": 0,
"replica": 0,
"labels": [
"string"
],
"cloneMode": "string",
"config": {
"healthCheck": {
"nodeStartupTimeout": "string",
"unhealthyConditions": [
{
"type": "string",
"status": "string",
"timeout": "string"
}
]
}
}
}
],
"name": "string",
"id": "string",
"tags": [
{
"autoCreated": false,
"name": "string"
}
],
"workerNodes": [
{
"cpu": 0,
"memory": 0,
"name": "string",
"networks": [
{
"label": "string",
"isManagement": false
}
],
"storage": 0,
"replica": 0,
"labels": [
"string"
],
"cloneMode": "string",
"config": {
"cpuManagerPolicy": {
"type": "string",
"policy": "string",
"properties": {
"kubeReserved": {
"cpu": 0,
"memoryInGiB": 0
},
"systemReserved": {
"cpu": 0,
"memoryInGiB": 0
}
}
},
"healthCheck": {
"nodeStartupTimeout": "string",
"unhealthyConditions": [
{
"type": "string",
"status": "string",
"timeout": "string"
}
]
}
}
}
]
}
string
clusterType
Required
Type of the cluster template.
Possible values are : MANAGEMENT, WORKLOAD,
object
clusterConfig
Required
clusterConfig
string
description
Optional
description
string
name
Required
name
string
id
Optional
id
array of object
tags
Optional
tags
array of object
workerNodes
Optional
List of nodepools configurations
Responses
200
Successfully updated cluster template.
Returns clusterTemplate of type(s) application/json
{
"clusterType": "string",
"clusterConfig": {
"cni": [
{
"name": "string"
}
],
"csi": [
{
"name": "string",
"properties": {
"name": "string",
"isDefault": false,
"timeout": "string"
}
}
],
"kubernetesVersion": "string",
"tools": [
{
"name": "string",
"version": "string"
}
],
"networking": [
{
"name": "string"
}
]
},
"description": "string",
"masterNodes": [
{
"cpu": 0,
"memory": 0,
"name": "string",
"networks": [
{
"label": "string",
"isManagement": false
}
],
"storage": 0,
"replica": 0,
"labels": [
"string"
],
"cloneMode": "string",
"config": {
"healthCheck": {
"nodeStartupTimeout": "string",
"unhealthyConditions": [
{
"type": "string",
"status": "string",
"timeout": "string"
}
]
}
}
}
],
"name": "string",
"id": "string",
"tags": [
{
"autoCreated": false,
"name": "string"
}
],
"workerNodes": [
{
"cpu": 0,
"memory": 0,
"name": "string",
"networks": [
{
"label": "string",
"isManagement": false
}
],
"storage": 0,
"replica": 0,
"labels": [
"string"
],
"cloneMode": "string",
"config": {
"cpuManagerPolicy": {
"type": "string",
"policy": "string",
"properties": {
"kubeReserved": {
"cpu": 0,
"memoryInGiB": 0
},
"systemReserved": {
"cpu": 0,
"memoryInGiB": 0
}
}
},
"healthCheck": {
"nodeStartupTimeout": "string",
"unhealthyConditions": [
{
"type": "string",
"status": "string",
"timeout": "string"
}
]
}
}
}
]
}
string
clusterType
Required
Type of the cluster template.
Possible values are : MANAGEMENT, WORKLOAD,
object
clusterConfig
Required
clusterConfig
string
description
Optional
description
string
name
Required
name
string
id
Optional
id
array of object
tags
Optional
tags
array of object
workerNodes
Optional
List of nodepools configurations
500
Internal Server Error
Returns errorResponse of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
On This Page
Cluster Templates Operations
POST
Create Cluster Template
GET
Download Cluster Template
PUT
Update Cluster Template
POST
Upload Cluster Template