Get backup details

Get backup details

get

Get detailed information about the specific backup.

Path parameters

backupNamestringRequired

Query parameters

clusterSeqstringRequired

Responses

200

OK

*/*

clusterNamestringOptional

clusterSeqintegerOptional

createdintegerOptional

Backup creation time

expirationintegerOptional

expiration date

includeNamespacesstring[]Optional

List of selected namespaces

includeResourcesstring[]Optional

List of selected resources (if the value is empty, all resources are selected)

isClusterBackupbooleanOptional

Whether to back up the entire cluster

isResourceAllBackupbooleanOptional

Whether to back up the entire resources

labelSelectorobjectOptional

Label selector (displays as null if not selected)

lastBackupRunningTimeintegerOptional

Working time of the most recently run backup

lastBackupStatusstringOptional

Status of recently run backup(New, InProgress, Completed, Failed, Deleting)

lastBackupTimeintegerOptional

Timestamp of most recent backup run

locationstringOptional

Storage name.

location_idstringOptional

Storage id.

namestringOptional

backup name

providerstringOptional

statusstringOptional

backup state(New, InProgress, Completed, Failed, Deleting)

Example: Completed

ttlintegerOptional

Backup retention period (unit: ms)

typestringOptional

backup type(backup: Run immediately once, schedule: Run automatically at a specified time)

get

/v1/backups/{backupName}

HTTPcURLJavaScriptPython

GET /v1/backups/{backupName}?clusterSeq=text HTTP/1.1
Accept: */*

200

OK

{
  "clusterName": "thingcluster",
  "clusterSeq": "1",
  "created": 1704705510,
  "expiration": 1707297510,
  "includeNamespaces": [
    "cocktail-license",
    "cocktail-system"
  ],
  "includeResources": [],
  "isClusterBackup": false,
  "isResourceAllBackup": true,
  "labelSelector": {
    "name": "value"
  },
  "lastBackupRunningTime": 132,
  "lastBackupStatus": "Completed",
  "lastBackupTime": 1706002826,
  "location": "minio",
  "location_id": "43f9ffdd-5763-400d-8bae-8289dfa1bfae",
  "name": "cocktail-backup",
  "provider": "minio",
  "status": "Completed",
  "ttl": 2592000000,
  "type": "backup"
}