Retrieve Cluster
Retrieve a cluster. Operation is available for container admins, system admins, developers and consumers.
Request
URI
GET
https://{api_host}/container-service/api/resources/clusters/{id}
COPY
Path Parameters
string
The id of the cluster to retrieve.
Header Parameters
string
x-project
Required
x-project
Responses
200
successful operation. Response body contains the retrieved cluster.
Returns ClusterDto of type(s) */*
{
"cpuUsage": "number",
"documentExpirationTimeMicros": "string",
"address": "string",
"memoryUsage": 0,
"nodeLinks": [
"string"
],
"systemContainersCount": 0,
"publicAddress": "string",
"type": "string",
"documentUpdateTimeMicros": "string",
"totalMemory": 0,
"totalCpu": "number",
"documentSelfLink": "string",
"clusterCreationTimeMicros": 0,
"name": "string",
"details": "string",
"tenantLinks": [
"string"
],
"containerCount": 0,
"status": "string"
}
number As double As double
cpuUsage
Optional
cpuUsage
string
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
address
Optional
address
integer As int64 As int64
memoryUsage
Optional
memoryUsage
array of string
nodeLinks
Optional
nodeLinks
integer As int32 As int32
systemContainersCount
Optional
systemContainersCount
string
publicAddress
Optional
publicAddress
string
type
Optional
type
Possible values are : DOCKER, VCH,
string
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
object
nodes
Optional
nodes
integer As int64 As int64
totalMemory
Optional
totalMemory
number As double As double
totalCpu
Optional
totalCpu
string
documentSelfLink
Optional
documentSelfLink
integer As int64 As int64
clusterCreationTimeMicros
Optional
clusterCreationTimeMicros
string
name
Optional
name
string
details
Optional
details
array of string
tenantLinks
Optional
tenantLinks
integer As int32 As int32
containerCount
Optional
containerCount
string
status
Optional
status
Possible values are : ON, OFF, DISABLED, WARNING,