Updates cluster reference and host cluster config

PUT 
https://api.spectrocloud.com/v1/clustergroups/:uid/hostCluster

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

Updates cluster reference and host cluster config

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

clusterRefs undefined[]
Array [
clusterNamestring
clusterUidstring
]
clustersConfig
Clusters config of cluster group
endpointTypestring
Possible values: [Ingress, LoadBalancer]
Host cluster endpoint type
hostClustersConfig undefined[]
Array [
clusterUidstring
endpointConfig
host cluster endpoint configuration
ingressConfig
Ingress configuration for exposing the virtual cluster's kube-apiserver
hoststring
portint64
loadBalancerConfig
Load balancer configuration for exposing the virtual cluster's kube-apiserver
externalIPsstring[]
externalTrafficPolicystring
loadBalancerSourceRangesstring[]
]
kubernetesDistroTypestring
Possible values: [k3s, cncf_k8s]
Default value: k3s
limitConfig
Cluster group limit config
cpuint32
Deprecated. Use field cpuMilliCore
cpuMilliCoreint32
CPU in milli cores
memoryint32
Deprecated. Use field memoryMiB
memoryMiBint32
Memory in MiB
overSubscriptionint32
Over subscription percentage
storageGiBint32
Storage in GiB
valuesstring

Responses

204

The resource was updated successfully

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X PUT 'https://api.spectrocloud.com/v1/clustergroups/:uid/hostCluster' \
-H 'Content-Type: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "clusterRefs": [
    {
      "clusterName": "string",
      "clusterUid": "string"
    }
  ],
  "clustersConfig": {
    "endpointType": "Ingress",
    "hostClustersConfig": [
      {
        "clusterUid": "string",
        "endpointConfig": {
          "ingressConfig": {
            "host": "string",
            "port": 0
          },
          "loadBalancerConfig": {
            "externalIPs": [
              "string"
            ],
            "externalTrafficPolicy": "string",
            "loadBalancerSourceRanges": [
              "string"
            ]
          }
        }
      }
    ],
    "kubernetesDistroType": "k3s",
    "limitConfig": {
      "cpu": 0,
      "cpuMilliCore": 0,
      "memory": 0,
      "memoryMiB": 0,
      "overSubscription": 0,
      "storageGiB": 0
    },
    "values": "string"
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

uid — pathrequired

ProjectUid — header

Body

{
  "clusterRefs": [
    {
      "clusterName": "string",
      "clusterUid": "string"
    }
  ],
  "clustersConfig": {
    "endpointType": "Ingress",
    "hostClustersConfig": [
      {
        "clusterUid": "string",
        "endpointConfig": {
          "ingressConfig": {
            "host": "string",
            "port": 0
          },
          "loadBalancerConfig": {
            "externalIPs": [
              "string"
            ],
            "externalTrafficPolicy": "string",
            "loadBalancerSourceRanges": [
              "string"
            ]
          }
        }
      }
    ],
    "kubernetesDistroType": "k3s",
    "limitConfig": {
      "cpu": 0,
      "cpuMilliCore": 0,
      "memory": 0,
      "memoryMiB": 0,
      "overSubscription": 0,
      "storageGiB": 0
    },
    "values": "string"
  }
}