Get details of a Kubernetes Cluster client

Select

SaaS

Customer Managed

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 int32

  name string
• tags object[]

  id int32

  name string

  value string
• etcdProtection object

  ETCD Protection options for a cluster

  id int32

  name string

  enabled boolean

  Denote if etcd protection is enabled

  plan object

  id int32

  name string
• applicationCount object

  Describe the Backup info for a Kubernetes Application

  pendingCount int32

  Count of Applications Pending backup

  protectedCount int32

  Count of Applications Protected

  notProtectedCount int32

  Count of Applications Not Protected

  neverBackedUpCount int32

  Count of Applications Never Backed up

  backupUpWithErrorCount int32

  Count of Applications Backed up with errors

  totalCount int32

  Count of total number of Applications

• instance object

  id int32

  name string
• clientGroups object[]

  id int32

  name string
• region object

  Workload region of the client

  id int32

  name string
• commonProperties 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 int32

  name string
• activityControl object

  Activity Control Options for Kubernetes Cluster

  enableBackup boolean

  enableRestore boolean
• options object

  Request definition for cluster advanced options

  imageRegistry object

  Request definition changing image registry options for cluster

  url string

  Specify image registry URL for internal image repository

  pullSecret string

  Specify image pull secret to authenticate with the image repository

  configNamespace string

  Specify the name of the Namespace where Commvault resources will be deployed

  jobStepWaitTime object

  Request definition changing job step wait time options for cluster

  workerPodStartup int32

  Specify wait time (in minutes) for Worker Pod to start

  resourceCleanup int32

  Specify wait time (in minutes) for resources to be deleted

  snapshotReady int32

  Specify wait time (in minutes) for snapshot to be Ready

  snapshotCleanup int32

  Specify wait time (in minutes) for snapshot to be deleted

• cloudStorage object

  Used to store the cloud storage info of the Kubernetes cluster

  region object

  id int32

  name string

  storagePool object

  id int32

  name string

{
  "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
  },
  "options": {
    "imageRegistry": {
      "url": "string",
      "pullSecret": "string"
    },
    "configNamespace": "string",
    "jobStepWaitTime": {
      "workerPodStartup": 0,
      "resourceCleanup": 0,
      "snapshotReady": 0,
      "snapshotCleanup": 0
    }
  },
  "cloudStorage": {
    "region": {
      "id": 0,
      "name": "string"
    },
    "storagePool": {
      "id": 0,
      "name": "string"
    }
  }
}

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
}

GET /v5/kubernetes/cluster/:clusterid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

clusterId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/Cluster/:clusterId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/Cluster/:clusterId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/Cluster/:clusterId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/Cluster/:clusterId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/Cluster/:clusterId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/Cluster/:clusterId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V5/Kubernetes/Cluster/:clusterId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'