Get details of a Kubernetes Cluster client
API to get details of a Kubernetes clusters with clusterId
Path Parameters
- clusterId int32 required
Responses
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- id int32
- name string
- displayName string
- apiServer string
API Server Endpoint of the cluster
- version string
Kubernetes client version
accessNode object[]
id int32name stringtags object[]
id int32name stringvalue stringetcdProtection object
ETCD Protection options for a cluster
id int32name stringenabled booleanDenote if etcd protection is enabled
plan object
id int32name stringapplicationCount object
Describe the Backup info for a Kubernetes Application
pendingCount int32Count of Applications Pending backup
protectedCount int32Count of Applications Protected
notProtectedCount int32Count of Applications Not Protected
neverBackedUpCount int32Count of Applications Never Backed up
backupUpWithErrorCount int32Count of Applications Backed up with errors
totalCount int32Count of total number of Applications
instance object
id int32name stringclientGroups object[]
id int32name stringregion object
Workload region of the client
id int32name stringcommonProperties object
Describe the common properties of a Kubernetes cluster
security object
Describe the client security details of a Kubernetes cluster
owners string[]List of owners associated to the cluster
associatedUserGroups object[]
id int32name stringactivityControl object
Activity Control Options for Kubernetes Cluster
enableBackup booleanenableRestore boolean
{
"id": 0,
"name": "string",
"displayName": "string",
"apiServer": "string",
"version": "string",
"accessNode": [
{
"id": 0,
"name": "string"
}
],
"tags": [
{
"id": 0,
"name": "string",
"value": "string"
}
],
"etcdProtection": {
"id": 0,
"name": "string",
"enabled": true,
"plan": {
"id": 0,
"name": "string"
}
},
"applicationCount": {
"pendingCount": 0,
"protectedCount": 0,
"notProtectedCount": 0,
"neverBackedUpCount": 0,
"backupUpWithErrorCount": 0,
"totalCount": 0
},
"instance": {
"id": 0,
"name": "string"
},
"clientGroups": [
{
"id": 0,
"name": "string"
}
],
"region": {
"id": 0,
"name": "string"
},
"commonProperties": {
"security": {
"owners": [
"string"
]
},
"associatedUserGroups": [
{
"id": 0,
"name": "string"
}
]
},
"activityControl": {
"enableBackup": true,
"enableRestore": true
}
}
Requested Details not found
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Loading...