Genereate Spec
Collects the specifications of the cluster and returns back the payload which can be used to deploy cluster of the same configuration. It may result in creation of new cluster template as well.
Request
URI
POST
https://{api_host}/tca/caas/api/v1/orgs/{orgId}/clusters/{clusterId}
COPY
Path Parameters
string
orgId
Optional
The identifier of the tenant
string
clusterId
Required
clusterId
Query Parameters
string
action
Required
action
Responses
200
Successfully generated the specifications of the cluster
Returns clusterSpec of type(s) application/json
{
"clusterTemplateId": "string",
"clusterType": "string",
"ipFamilies": "string",
"description": "string",
"variables": [
{
"name": "string"
}
],
"clusterConfig": {
"csi": [
{
"name": "string",
"properties": {
"serverIP": "string",
"mountPath": "string",
"datastoreUrl": "string",
"region": "string",
"zone": "string"
}
}
],
"tools": [
{
"name": "string",
"properties": {
"extensionId": "string",
"type": "string",
"url": "string",
"username": "string"
}
}
],
"networking": [
{
"name": "string",
"properties": {
"aviController": {
"aviUsername": "string",
"aviCaDataB64": "string"
},
"loadBalancerAndIngressService": {
"cloudName": "string",
"defaultServiceEngineGroup": "string",
"defaultVipNetwork": "string",
"defaultVipNetworkCidr": "string"
}
}
}
],
"systemSettings": [
{
"name": "string",
"properties": {
"host": "string",
"port": 0,
"protocol": "string"
}
}
]
},
"airgapConfig": {
"type": "string",
"extensionId": "string",
"fqdn": "string",
"ip": "string",
"caCert": "string"
},
"proxyConfig": {
"type": "string",
"extensionId": "string",
"httpProxy": "string",
"httpsProxy": "string",
"noProxy": "string",
"caCert": "string"
},
"hcxCloudUrl": "string",
"vimOwnerHcxCloudUrl": "string",
"vimId": "string",
"vimOwnerVimId": "string",
"hcxUUID": "string",
"resourceProviderHcxUUID": "string",
"managementClusterId": "string",
"masterNodes": [
{
"name": "string",
"networks": [
{
"label": "string",
"networkName": "string",
"mtu": 0,
"nameservers": [
"string"
]
}
],
"placementParams": [
{
"name": "string",
"type": "string"
}
]
}
],
"placementParams": [
{
"name": "string",
"type": "string"
}
],
"vmTemplate": "string",
"workerNodes": [
{
"name": "string",
"networks": [
{
"label": "string",
"networkName": "string",
"mtu": 0,
"nameservers": [
"string"
]
}
],
"placementParams": [
{
"name": "string",
"type": "string"
}
]
}
]
}string
clusterTemplateId
Required
clusterTemplateId
string
clusterType
Required
clusterType
Possible values are : MANAGEMENT, WORKLOAD,
string
ipFamilies
Optional
ipFamilies
Possible values are : IPv4, IPv6,
string
description
Optional
description
array of object
variables
Optional
Variables can be used to customize the Cluster.
object
clusterConfig
Optional
clusterConfig
object
airgapConfig
Optional
airgapConfig
string
hcxCloudUrl
Required
hcxCloudUrl
string
vimOwnerHcxCloudUrl
Optional
vimOwnerHcxCloudUrl
string
vimId
Optional
vimId
string
vimOwnerVimId
Optional
vimOwnerVimId
string
hcxUUID
Optional
hcxUUID
string
resourceProviderHcxUUID
Optional
resourceProviderHcxUUID
string
managementClusterId
Optional
managementClusterId
array of object
masterNodes
Required
Pool of nodes on which Kubernetes control plane can run.
array of object
placementParams
Required
placementParams
string
vmTemplate
Required
OS Image With Kubernetes
array of object
workerNodes
Optional
Pool of worker nodes on which Network Functions can run. Each Node Pool can be deployed on a vSphere Resource Pool. All the worker nodes in a node pool contain same Kubelet and Operating System Configuration. It is recommended that a Node Pool should be used by only one Network Function, if it has Infrastructure requirements.
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
Infra Operations
POST
Abort Cluster Operation
POST
Add Repo Details
PUT
Change Cluster Password
POST
Create Cluster Node Pool
DELETE
Delete Node Pool
POST
Deploy Cluster
PUT
Edit Cluster
PUT
Edit Cluster Config
PUT
Edit Node Pool
POST
Genereate Spec
GET
Get Cluster Config
GET
Get Clusters
GET
Get Clusters Node Pools
GET
Get K8 Cluster Node Pool
GET
Get Node Pool Customization
GET
Get Repo Details
POST
Kuberenetes Version Upgrade Matrix
PUT
Pause Node Pool
DELETE
Remove Repo Details
POST
Retry Cluster Operation
GET
Supported Kubernetes Versions
PUT
Sync Esx Info
PUT
Transform Cluster
PUT
Unpause Node Pool
PUT
Update Repo Details
PUT
Upgrade Cluster
PUT
Upgrade Cluster Addon
GET
Upgrade History
GET
Validate Upgrade Cluster
GET
Vsphere Csi Zone Support