View Backup Files
This guide walks you through how to view automatically or manually created backup files.
Backup file status
The status of a backup file can vary, and the possible statuses are as follows:
-
CREATING
If a backup file is in this status, you cannot create another one within the same cluster. However, you go to the Jobs page can click ... in the Actions column and choose Cancel to terminate the process.
-
AVAILABLE
After the status changes to this, you can click ... in the Actions column to
If the status of your backup file is neither of the two, errors may occur. Please try again. If you continue to experience errors, please contact us without hesitation.
View all backup files
- Cloud Console
- Bash
List backup files created for a cluster. For details on parameters, refer to List Backups.
curl --request GET \
--url "${BASE_URL}/v2/backups" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json"
Expected output:
{
"code": 0,
"data": {
"count": 10,
"currentPage": 1,
"pageSize": 10,
"backups": [
{
"backupId": "backup1_0b9d15a0ddexxxx",
"projectId": "proj-20e13e974c7d659a83xxxx",
"backupName": "Dedicated-01_backup3",
"backupType": "CLUSTER",
"creationMethod": "AUTO",
"status": "CREATING",
"size": 0,
"expireTime": "2024-09-02T02:27:51Z",
"clusterId": "in01-3e5ad8adc38xxxx",
"clusterName": "Dedicated-01",
"createTime": "2024-08-26T02:27:51Z"
},
...
]
}
}
View backup file details
- Cloud Console
- Bash
View the details of a specific backup file. For details on parameters, refer to Describe Backup.
curl --request GET \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json"
Expected output:
{
"code": 0,
"data": {
"clusterId": "in01-3e5ad8adc38xxxx",
"clusterName": "Dedicated-01",
"regionId": "aws-us-west-2",
"projectId": "proj-20e13e974c7d659a83xxxx",
"backupId": "backup1_0b9d15a0ddexxxx",
"backupName": "Dedicated-01_backup3",
"backupType": "CLUSTER",
"creationMethod": "AUTO",
"status": "AVAILABLE",
"size": 0,
"collections": [],
"createTime": "2024-08-26T02:27:51Z",
"expireTime": "2024-09-02T02:27:51Z"
}
}