Get Cluster Template

Get Cluster Template

Api to get all cluster template

Request
URI
GET
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

Authentication
This operation uses the following authentication methods.
Responses
200

Get 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

array of MasterNodes
masterNodes
Required

Control plane nodes configurations

string
name
Required

name

string
id
Optional

id

array of object
tags
Optional

tags

array of object
workerNodes
Optional

List of nodepools configurations


On This Page
Infra Cluster Template Operations
DELETE
Delete Cluster Template
GET
Get Cluster Template
GET
Get Cluster Templates