clusters

Get cluster status

Getting cluster status

get/api/v1/orgs/{orgId}/clusters/{id}

Path parameters

orgIdinteger required

Organization identifier

idinteger required

Cluster identifier

Response

Getting cluster succeeded

statusstring

statusMessagestring

namestring

cloudstring

distributionstring

versionstring

spotboolean

locationstring

idinteger

loggingboolean

monitoringboolean

securityscanboolean

createdAtstring

startedAtstring

creatorNamestring

creatorIdinteger

regionstring

nodePoolsobject

Example response

{
  "securityscan": false,
  "creatorName": "userName",
  "creatorId": 1,
  "startedAt": "2018-07-03T14:23:29+02:00",
  "distribution": "gke",
  "monitoring": false,
  "version": "1.12.6-gke.10",
  "oidc": {
    "clientId": "clientId",
    "idpUrl": "idpUrl",
    "clientSecret": "clientSecret",
    "enabled": true
  },
  "statusMessage": "Cluster is running",
  "cloud": "google",
  "createdAt": "2018-07-03T14:23:19+02:00",
  "spot": false,
  "name": "myClusterName",
  "logging": false,
  "totalSummary": {
    "memory": {
      "allocatable": "4",
      "request": "380m",
      "limit": "100m",
      "capacity": "4"
    },
    "cpu": {
      "allocatable": "4",
      "request": "380m",
      "limit": "100m",
      "capacity": "4"
    },
    "status": "status"
  },
  "location": "us-central1-a",
  "id": 1,
  "nodePools": {
    "key": {
      "count": 1,
      "instanceType": "n1-standard-1"
    }
  },
  "region": "us-central1",
  "status": "RUNNING"
}

Changes

Changed in 5 of the 50 revisions of this API.225

Jan 22, 20211d054e88f7571See the full diff
- ○
  removed from the / response property oneOf list for the response status
  response-property-one-of-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 8, 2020506addd914c012See the full diff
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
May 5, 2020316119f4ae091See the full diff
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
May 1, 2020ad0c28b75acd1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Apr 24, 20205186ea64aa56111See the full diff
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  removed from the / response property oneOf list for the response status
  response-property-one-of-removed
This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history