Get Kubernetes Cluster
API code: GET_KUBERNETES_CLUSTER
Pre-authorized role(s): TENANT_USER
| TENANT_ADMIN
Platform(s): AMAZON
| OSIS
| CLOUDIAN
| ECS
Request
URI
GET
https://apaas-29.eng.vmware.com//api/v1/k8s/clusters/{clusterId}
COPY
Path Parameters
string
clusterId
Required
The ID of the protected Kubernetes cluster.
Responses
200
OK
Returns Cluster of type(s) application/json
{
"id": "string",
"name": "string",
"location": "string",
"ownerName": "string",
"ownerId": "string",
"health": "string",
"nodeCount": 0,
"protectionStatus": "string",
"bucket": "string",
"protectedBy": "string",
"protecting": false,
"protectingRegion": "string",
"nextBackup": 0,
"errorMessages": [
"string"
],
"restoreStatus": {
"phase": "string",
"validationErrors": [
"string"
],
"warnings": 0,
"errors": 0,
"failureReason": "string",
"startTimestamp": "string",
"completionTimestamp": "string",
"totalItems": 0,
"itemsRestored": 0
},
"appName": "string",
"appId": "string",
"status": "string",
"creationDate": "string",
"backupStorageLocation": {
"name": "string",
"bucket": "string",
"region": "string",
"caCert": "string",
"sseS3": false,
"status": "string"
},
"volumeSnapshotLocation": {
"name": "string",
"provider": "string",
"config": {
"config": "string"
}
},
"accessKey": "string",
"storageUserId": "string",
"schedule": {
"metadata": {
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"creationTimestamp": "string",
"annotations": {
"annotations": "string"
},
"labels": {
"labels": "string"
}
},
"spec": {
"template": {
"includedNamespaces": [
"string"
],
"excludedNamespaces": [
"string"
],
"includedResources": [
"string"
],
"excludedResources": [
"string"
],
"includeClusterResources": "string",
"orderedResources": "string",
"labelSelector": {
"labelSelector": "string"
},
"snapshotVolumes": false,
"ttl": "string",
"storageLocation": "string",
"volumeSnapshotLocations": [
"string"
],
"advancedOptions": {
"advancedOptions": "string"
}
},
"schedule": "string"
},
"status": {
"phase": "string",
"lastBackup": "string",
"validationErrors": [
"string"
]
}
},
"supportSnapshotVolume": false,
"message": "string",
"statusUpdateDate": "string",
"fullControl": false,
"externalCluster": false,
"orgName": "string",
"k8sVersion": "string",
"k8sProvider": "string"
}
string
id
Optional
id
string
name
Optional
name
string
location
Optional
location
string
ownerName
Optional
ownerName
string
ownerId
Optional
ownerId
string
health
Optional
health
Possible values are : GREEN, RED,
integer As int32 As int32
nodeCount
Optional
nodeCount
string
protectionStatus
Optional
protectionStatus
Possible values are : UNPROTECTED, PROTECTING, PROTECTED, FAILED, UNPROTECTING,
string
bucket
Optional
bucket
string
protectedBy
Optional
protectedBy
boolean
protecting
Optional
protecting
string
protectingRegion
Optional
protectingRegion
Possible values are : NONE, LOCAL, REMOTE,
integer As int64 As int64
nextBackup
Optional
nextBackup
array of string
errorMessages
Optional
errorMessages
string
appName
Optional
appName
string
appId
Optional
appId
string
status
Optional
status
Possible values are : UNPROTECTED, PROTECTING, PROTECTED, FAILED, UNPROTECTING,
string As date-time As date-time
creationDate
Optional
creationDate
string
accessKey
Optional
accessKey
string
storageUserId
Optional
storageUserId
boolean
supportSnapshotVolume
Optional
supportSnapshotVolume
string
message
Optional
message
string As date-time As date-time
statusUpdateDate
Optional
statusUpdateDate
boolean
fullControl
Optional
fullControl
boolean
externalCluster
Optional
externalCluster
string
orgName
Optional
orgName
string
k8sVersion
Optional
k8sVersion
string
k8sProvider
Optional
k8sProvider
Possible values are : CSE_LEGACY, CSE_NATIVE, TKG, EXTERNAL, CAPVCD,
Kubernetes Backup And Restore Operations
POST
Create Kubernetes Cluster Backup
POST
Create Kubernetes Cluster Restore
DELETE
Delete External Kubernetes Cluster
DELETE
Delete Kubernetes Cluster Backup
DELETE
Delete Kubernetes Cluster Restore
DELETE
Disable Kubernetes Cluster Protection
POST
Enable Kubernetes Cluster Protection
GET
Get Kubernetes Cluster
GET
Get Kubernetes Cluster Backup
GET
Get Kubernetes Cluster Protection
GET
Get Kubernetes Cluster Restore
GET
List Kubernetes Cluster Backups
GET
List Kubernetes Cluster Namespaces
GET
List Kubernetes Cluster Restores
GET
List Kubernetes Clusters
POST
Protect External Kubernetes Cluster
PUT
Update Kubernetes Cluster Backup
PUT
Update Kubernetes Cluster Protection