Get restore point details

Get restore point details

get

Get detailed information for the specific restore point.

Path parameters

restorePointNamestringRequired

Query parameters

clusterSeqstringRequired

Responses

200

OK

*/*

clusterNamestringOptionalExample: thingcluster

clusterSeqstringOptionalExample: 1

createdintegerOptional

Backup creation time

Example: 1704705510

errorsintegerOptional

number of errors

Example: 0

expirationintegerOptional

expiration date

Example: 1707297510

hasJobbooleanOptional

Backup existence status

Example: true

includeNamespacesstring[]Optional

List of selected namespaces

Example: ["cocktail-license","cocktail-system"]

includeResourcesstring[]Optional

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

isClusterBackupbooleanOptional

Whether to back up the entire cluster

Example: false

isResourceAllBackupbooleanOptional

Whether to back up the entire resources

Example: true

itemsBackupedUpintegerOptional

Number of resources for which backup has been completed

Example: 45

jobNamestringOptional

backup name

Example: cocktail-backup

labelSelectorobjectOptional

Label selector (displays as null if not selected)

locationstringOptional

storage name

Example: minio

location_idstringOptional

storage id

Example: 43f9ffdd-5763-400d-8bae-8289dfa1bfae

namestringOptional

restore points name

Example: cocktail-backup

providerstringOptionalExample: minio

runningTimeintegerOptional

runningtime (unit: s)

Example: 154

sizeintegerOptional

volume size

Example: 329759314

statusstringOptional

restore points status(New, InProgress, Completed, Failed, Deleting)

Example: Completed

TTLintegerOptional

Backup retention period (unit: ms)

Example: 2592000000

totalItemsintegerOptional

Total number of backup resources

Example: 45

warningsintegerOptional

number of warnings

Example: 0

get

/v1/backups/restore-point/{restorePointName}

HTTPcURLJavaScriptPython

GET /v1/backups/restore-point/{restorePointName}?clusterSeq=text HTTP/1.1
Accept: */*

200

OK

[
  {
    "clusterName": "thingcluster",
    "clusterSeq": "1",
    "created": 1704705510,
    "errors": 0,
    "expiration": 1707297510,
    "hasJob": true,
    "includeNamespaces": [
      "cocktail-license",
      "cocktail-system"
    ],
    "includeResources": [],
    "isClusterBackup": false,
    "isResourceAllBackup": true,
    "itemsBackupedUp": 45,
    "jobName": "cocktail-backup",
    "labelSelector": null,
    "location": "minio",
    "location_id": "43f9ffdd-5763-400d-8bae-8289dfa1bfae",
    "name": "cocktail-backup",
    "provider": "minio",
    "runningTime": 154,
    "size": 329759314,
    "status": "Completed",
    "TTL": 2592000000,
    "totalItems": 45,
    "warnings": 0
  }
]