Checking the status of a Data Lake backup
After configuring and running a backup of your Data Lake, you can check the status of the backup operation.
Checking backup status
Use the following command to see the status of a Data Lake
backup:
$ cdp datalake backup-datalake-status
--datalake-name <name>
[--backup-id <generated-ID>]
[--backup-name <name>]
[--cli-input-json <string>]
[--generate-cli-skeleton]
where
the options are the following:Option | Example | Description |
---|---|---|
--datalake-name | finance-dl | This is the name of the Data Lake as configured in the CDP environment. |
[--backup-id] | 415927d9-9f7d-4d42-8000-71630e5938ca |
The system-generated ID for the backup. If you don't know the ID or name for
the backup, run the list-datalake-backups command to see the
available backups.If neither an ID or a name is provided, the command shows the status of the most recent backup operation. |
[--backup-name] | pre-upgrade0420 |
The user-provided name for the backup. If you don't know the name or ID for
the backup, run the list-datalake-backups command to see the
available backups.If neither an ID or a name is provided, the command shows the status of the most recent backup operation. |
--cli-input-json <string> |
Performs service operation based on the JSON string provided. The JSON string
follows the format provided by --generate-cli-skeleton . If other
arguments are provided on the command line, the CLI values will override the
JSON-provided values. |
|
--generate-cli-skeleton |
Prints a sample JSON configuration file to standard output. If this argument is specified, only the template is produced: the list-backup command does not run. |
For example:
$ cdp datalake backup-datalake-status
--datalake-name finance-dl --backup-id
415927d9-9f7d-4d42-8000-71630e5938ca
The
output of the command shows the current status of the backup operation. Note the internal
state shows the status of each separate backup operation. If any of the individual backups
fail, the overall status is failed and the backup cannot be
restored.{
"accountId": "9d74eee4-1cad-45d7-b654-7ccf9edbb73d",
"userCrn": "crn:altus:iam:us-west-1:9d74eee4-1cad-45d7-b654-7ccf9
edbb73d:user:c44ac52c-625b-410c-a46c-8db204de4d92",
"internalState": "{ATLAS_ENTITY_AUDIT_EVENTS_TABLE=SUCCESSFUL, EDGE_INDEX_COLLECTION=SUCCESSFUL, DATABASE=SUCCESSFUL, FULLTEXT_INDEX_COLLECTION=SUCCESSFUL, ATLAS_JANUS_TABLE=SUCCESSFUL, RANGER_AUDITS_COLLECTION=SUCCESSFUL, VERTEX_INDEX_COLLECTION=SUCCESSFUL}",
"status": "SUCCESSFUL",
"startTIme": "2021-04-20 20:10:16.567"
"endTIme": "2021-04-20 20:32:22.012"
"backupLocation":"s3a://acme-finance-admin-bucket/backup-archive
/backup-archive",
"backupName": "pre-upgrade0420"
"failureReason": ""
}
Listing metadata for all backups
Use the following command to show all Data Lake backups in a given storage
location:
$ cdp datalake list-datalake-backups
--datalake-name <name>
[--cli-input-json <string>]
[--generate-cli-skeleton]
where
the options are the following:Option | Example | Description |
---|---|---|
--datalake-name <name> | finance-dl |
This is the name of the Data Lake as configured in the CDP environment. |
--cli-input-json <string> |
Performs service operation based on the JSON string provided. The JSON string
follows the format provided by --generate-cli-skeleton . If other arguments are provided on the command line, the CLI values will override the JSON-provided values. |
|
--generate-cli-skeleton |
Prints a sample JSON configuration file to standard output. If this argument is specified, only the template is produced: the list-backup command does not run. |
For
example:
$ cdp datalake list-datalake-backups
--datalake-name finance-dl
The
output of the command shows the metadata for all backups stored for this Data Lake. Note
that if a backup is listed with status failed, it cannot be
restored.{
"accountId": "9d74eee4-1cad-45d7-b654-7ccf9edbb73d",
"userCrn": "crn:altus:iam:us-west-1:9d74eee4-1cad-45d7-b654-7ccf9
edbb73d:user:c44ac52c-625b-410c-a46c-8db204de4d92",
"backupId": "415927d9-9f7d-4d42-8000-71630e5938ca",
"internalState": "{ATLAS_ENTITY_AUDIT_EVENTS_TABLE=SUCCESSFUL, EDGE_INDEX_COLLECTION=SUCCESSFUL, DATABASE=SUCCESSFUL, FULLTEXT_INDEX_COLLECTION=SUCCESSFUL, ATLAS_JANUS_TABLE=SUCCESSFUL, RANGER_AUDITS_COLLECTION=SUCCESSFUL, VERTEX_INDEX_COLLECTION=SUCCESSFUL}",
"status": "SUCCESSFUL",
"startTIme": "2021-04-20 20:10:16.567"
"endTIme": "2021-04-20 20:32:22.012"
"backupLocation":"s3a://acme-finance-admin-bucket/backup-archive
/backup-archive",
"backupName": "pre-upgrade0420"
"failureReason": "null"
}
{
"accountId": "9d74eee4-1cad-45d7-b654-7ccf9edbb73d",
"userCrn": "crn:altus:iam:us-west-1:9d74eee4-1cad-45d7-b654-7ccf9
edbb73d:user:c44ac52c-625b-410c-a46c-8db204de4d92",
"backupId": "6543de7d-8d22-23e4-9123-54375ec123b4",
"internalState": "{ATLAS_ENTITY_AUDIT_EVENTS_TABLE=SUCCESSFUL, EDGE_INDEX_COLLECTION=SUCCESSFUL, DATABASE=SUCCESSFUL, FULLTEXT_INDEX_COLLECTION=SUCCESSFUL, ATLAS_JANUS_TABLE=SUCCESSFUL, RANGER_AUDITS_COLLECTION=SUCCESSFUL, VERTEX_INDEX_COLLECTION=SUCCESSFUL}",
"status": "SUCCESSFUL",
"startTIme": "2021-04-19 20:09:41.341"
"endTIme": "2021-04-19 20:28:22.822"
"backupLocation":"s3a://acme-finance-admin-bucket/backup-archive
/backup-archive",
"backupName": ""
"failureReason": "null"
}...