Cluster Groups

https://api.spectrocloud.com/v1/clustergroups

summary:
Create cluster groups
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"clusterRefs": [
{
"clusterName": "string",
"clusterUid": "string"
}
],
"clustersConfig": {
"endpointType": "string",
"hostClustersConfig": [
{
"clusterUid": "string",
"endpointConfig": {
"ingressConfig": {
"host": "string"
},
"loadBalancerConfig": {
"externalIPs": [
"string"
],
"externalTrafficPolicy": "string",
"loadBalancerSourceRanges": [
"string"
]
}
}
}
],
"limitConfig": {
"cpu":deprecated "integer",
"cpuMilliCore": "integer",
"memory":deprecated "integer",
"memoryMiB": "integer",
"overSubscription": "integer",
"storageGiB": "integer"
},
"values": "string"
},
"type": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/clustergroups/developerCredit/usage/{scope}

summary:
Get cluster group developer credit usage by scope
Path parameters:
NameTypeDescriptionRequired
scopestringyes
200
Cluster group developer credit usage
{
"allocatedCredit": {
"cpu": "number",
"memoryGiB": "number",
"nestedClustersLimit": "number",
"storageGiB": "integer"
},
"usedCredit": {
"cpu": "number",
"memoryGiB": "number",
"nestedClustersLimit": "number",
"storageGiB": "integer"
}
}

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

summary:
Retrieves a list of cluster groups host cluster summary
200
An array of cluster groups of host cluster type summary
{
"summaries": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"cpu":deprecated {
"allocated": "number",
"used": "number"
},
"endpointType": "string",
"hostClusters": [
{
"kind": "string",
"name": "string",
"projectUid": "string",
"tenantUid": "string",
"uid": "string"
}
],
"hostClustersCount": "integer",
"memory":deprecated {
"allocated": "number",
"used": "number"
},
"nestedClusters":deprecated [
{
"kind": "string",
"name": "string",
"projectUid": "string",
"tenantUid": "string",
"uid": "string"
}
],
"nestedClustersCount": "integer",
"scope": "string"
}
}
]
}

https://api.spectrocloud.com/v1/clustergroups/hostCluster/metadata

summary:
Retrieves a list of cluster groups host cluster metadata
200
An array of cluster groups host cluster metadata items
{
"items": [
{
"name": "string",
"scope": "string",
"uid": "string"
}
]
}

https://api.spectrocloud.com/v1/clustergroups/teams/{teamUid}/roles

summary:
Returns the specified team's cluster groups and roles data
Path parameters:
NameTypeDescriptionRequired
teamUidstringyes
200
OK
{
"clusterGroups": [
{
"inheritedRoles": [
{
"name": "string",
"uid": "string"
}
],
"name": "string",
"roles": [
{
"name": "string",
"uid": "string"
}
],
"uid": "string"
}
]
}

https://api.spectrocloud.com/v1/clustergroups/teams/{teamUid}/roles

summary:
Updates the cluster group roles for the specified team
Path parameters:
NameTypeDescriptionRequired
teamUidstringyes
{
"clusterGroups": [
{
"roles": [
"string"
],
"uid": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/clustergroups/users/{userUid}/roles

summary:
Returns the specified user cluster groups and Roles information
description:
Returns the cluster groups and roles for the user
Path parameters:
NameTypeDescriptionRequired
userUidstringyes
200
OK
{
"clusterGroups": [
{
"inheritedRoles": [
{
"name": "string",
"uid": "string"
}
],
"name": "string",
"roles": [
{
"name": "string",
"uid": "string"
}
],
"uid": "string"
}
]
}

https://api.spectrocloud.com/v1/clustergroups/users/{userUid}/roles

summary:
Updates the cluster group roles for the user
description:
Updates the cluster group roles for the user
Path parameters:
NameTypeDescriptionRequired
userUidstringyes
{
"clusterGroups": [
{
"roles": [
"string"
],
"uid": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/clustergroups/validate/name

summary:
Validates the cluster groups name
Parameters:
NameTypeDescriptionRequired
namestringyes
204
Ok reponse without content

https://api.spectrocloud.com/v1/clustergroups/{uid}

summary:
Deletes the specified cluster group
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/clustergroups/{uid}

summary:
Returns the specified cluster groups
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"clusterRefs": [
{
"clusterName": "string",
"clusterUid": "string"
}
],
"clustersConfig": {
"endpointType": "string",
"hostClustersConfig": [
{
"clusterUid": "string",
"endpointConfig": {
"ingressConfig": {
"host": "string"
},
"loadBalancerConfig": {
"externalIPs": [
"string"
],
"externalTrafficPolicy": "string",
"loadBalancerSourceRanges": [
"string"
]
}
}
}
],
"limitConfig": {
"cpu":deprecated "integer",
"cpuMilliCore": "integer",
"memory":deprecated "integer",
"memoryMiB": "integer",
"overSubscription": "integer",
"storageGiB": "integer"
},
"values": "string"
},
"type": "string"
},
"status": {
"isActive": "boolean"
}
}

deprecated

https://api.spectrocloud.com/v1/clustergroups/{uid}/clusters

summary:
Updates the specified cluster groups clusters
description:
Deprecated: Use PUT /v1/clustergroups/{uid}/hostCluster
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"clusterRefs": [
{
"clusterName": "string",
"clusterUid": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/clustergroups/{uid}/hostCluster

summary:
Updates cluster reference and host cluster config
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"clusterRefs": [
{
"clusterName": "string",
"clusterUid": "string"
}
],
"clustersConfig": {
"endpointType": "string",
"hostClustersConfig": [
{
"clusterUid": "string",
"endpointConfig": {
"ingressConfig": {
"host": "string"
},
"loadBalancerConfig": {
"externalIPs": [
"string"
],
"externalTrafficPolicy": "string",
"loadBalancerSourceRanges": [
"string"
]
}
}
}
],
"limitConfig": {
"cpu":deprecated "integer",
"cpuMilliCore": "integer",
"memory":deprecated "integer",
"memoryMiB": "integer",
"overSubscription": "integer",
"storageGiB": "integer"
},
"values": "string"
}
}
204
The resource was updated successfully

deprecated

https://api.spectrocloud.com/v1/clustergroups/{uid}/hostCluster/config

summary:
Updates the host cluster config in cluster group
description:
Deprecated: Use PUT /v1/clustergroups/{uid}/hostCluster
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"endpointType": "string",
"hostClustersConfig": [
{
"clusterUid": "string",
"endpointConfig": {
"ingressConfig": {
"host": "string"
},
"loadBalancerConfig": {
"externalIPs": [
"string"
],
"externalTrafficPolicy": "string",
"loadBalancerSourceRanges": [
"string"
]
}
}
}
],
"limitConfig": {
"cpu":deprecated "integer",
"cpuMilliCore": "integer",
"memory":deprecated "integer",
"memoryMiB": "integer",
"overSubscription": "integer",
"storageGiB": "integer"
},
"values": "string"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/clustergroups/{uid}/meta

summary:
Updates the specified cluster groups meta
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
}
204
The resource was updated successfully