Backup Resource Service List
List Backups.
Request
URI
GET
https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/clusters/{searchScope.clusterName}/dataprotection/backups
COPY
Path Parameters
string
searchScope.clusterName
Required
Scope search to the specified cluster_name; supports globbing; default (*).
Query Parameters
string
searchScope.managementClusterName
Optional
Scope search to the specified management_cluster_name; supports globbing; default (*).
string
searchScope.provisionerName
Optional
Scope search to the specified provisioner_name; supports globbing; default (*).
string
searchScope.name
Optional
Scope search to the specified name; supports globbing; default (*).
string
sortBy
Optional
Sort Order.
string
query
Optional
TQL query string.
string
pagination.offset
Optional
Offset at which to start returning records.
string
pagination.size
Optional
Number of records to return.
boolean
includeTotalCount
Optional
Include total count.
Responses
200
A successful response.
Returns vmware.tanzu.manage.v1alpha1.cluster.dataprotection.backup.ListBackupsResponse of type(s) */*
{
"backups": [
{
"type": {
"kind": "string",
"version": "string",
"package": "string"
},
"fullName": {
"orgId": "string",
"managementClusterName": "string",
"provisionerName": "string",
"clusterName": "string",
"name": "string"
},
"meta": {
"uid": "string",
"generation": "string",
"resourceVersion": "string",
"creationTime": "string",
"updateTime": "string",
"description": "string",
"parentReferences": [
{
"rid": "string",
"uid": "string"
}
]
},
"spec": {
"includedNamespaces": [
"string"
],
"excludedNamespaces": [
"string"
],
"includedResources": [
"string"
],
"excludedResources": [
"string"
],
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
},
"snapshotVolumes": false,
"ttl": "string",
"includeClusterResources": false,
"storageLocation": "string",
"volumeSnapshotLocations": [
"string"
],
"orLabelSelectors": [
{
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
],
"defaultVolumesToRestic": false,
"csiSnapshotTimeout": "string",
"defaultVolumesToFsBackup": false,
"hooks": {
"resources": [
{
"name": "string",
"includedNamespaces": [
"string"
],
"excludedNamespaces": [
"string"
],
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
},
"preHooks": [
{
"exec": {
"container": "string",
"command": [
"string"
],
"onError": "string",
"timeout": "string"
}
}
],
"postHooks": [
{
"exec": {
"container": "string",
"command": [
"string"
],
"onError": "string",
"timeout": "string"
}
}
]
}
]
},
"includedClusterScopedResources": [
"string"
],
"excludedClusterScopedResources": [
"string"
],
"includedNamespaceScopedResources": [
"string"
],
"excludedNamespaceScopedResources": [
"string"
],
"snapshotMoveData": false
},
"status": {
"observedGeneration": "string",
"phase": "string",
"phaseInfo": "string",
"availablePhases": [
"string"
],
"validationErrors": [
"string"
],
"startTimestamp": "string",
"completionTimestamp": "string",
"volumeSnapshotsAttempted": 0,
"volumeSnapshotsCompleted": 0,
"expiration": "string",
"formatVersion": "string",
"progress": {
"totalItems": 0,
"itemsBackedUp": 0
},
"gatherBackupResourcesStatus": {
"phase": "string",
"phaseInfo": "string"
},
"resticBackupsCompleted": [
"string"
],
"resticBackupsAttempted": [
"string"
],
"failureReason": "string",
"csiVolumeSnapshotsAttempted": 0,
"csiVolumeSnapshotsCompleted": 0,
"resourceListUrl": "string",
"backupLogsUrl": "string",
"volumeBackups": [
{
"pvcName": "string",
"pvcNamespace": "string",
"pvName": "string",
"scName": "string",
"size": "string",
"method": "string",
"podInfo": {
"podName": "string",
"podNamespace": "string",
"podVolumeName": "string",
"backupPhase": "string"
}
}
]
}
}
],
"totalCount": "string"
}
default
An unexpected error response.
Returns grpc.gateway.runtime.Error of type(s) */*
{
"error": "string",
"code": 0,
"message": "string",
"details": [
{
"typeUrl": "string",
"value": "string"
}
]
}
Backup Resource Service Operations
POST
Backup Resource Service Create
DELETE
Backup Resource Service Delete
GET
Backup Resource Service Get
GET
Backup Resource Service List